Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoMarkerSet Class Reference
[Nodes]

The SoMarkerSet class displays a set of 2D bitmap markers in 3D. More...

#include <Inventor/nodes/SoMarkerSet.h>

Inheritance diagram for SoMarkerSet:

SoPointSet SoNonIndexedShape SoVertexShape SoShape SoNode SoFieldContainer SoBase List of all members.

Public Types

enum  MarkerType

Public Methods

 SoMarkerSet (void)
virtual void GLRender (SoGLRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

Static Public Methods

void initClass (void)
int getNumDefinedMarkers (void)
void addMarker (int idx, const SbVec2s &size, const unsigned char *bytes, SbBool isLSBFirst=TRUE, SbBool isUpToDown=TRUE)
SbBool getMarker (int idx, SbVec2s &size, const unsigned char *&bytes, SbBool &isLSBFirst)
SbBool removeMarker (int idx)
SbBool isMarkerBitSet (int idx, int bitNumber)

Public Attributes

SoMFInt32 markerIndex

Protected Methods

virtual ~SoMarkerSet ()

Detailed Description

The SoMarkerSet class displays a set of 2D bitmap markers in 3D.

This node uses the coordinates currently on the state (or in the vertexProperty field) in order. The numPoints field specifies the number of points in the set.

In addition to supplying the user with a set of standard markers to choose from, it is also possible to specify one's own bitmaps for markers.

This node class is an extension versus the original SGI Inventor v2.1 API. In addition to being a Coin extension, it is also present in TGS' Inventor implementation (except TGS doesn't support the NONE markerIndex value).

Since:
TGS Inventor 2.5
Coin 1.0


Member Enumeration Documentation

enum SoMarkerSet::MarkerType
 

Defines the different standard markers.


Constructor & Destructor Documentation

SoMarkerSet::SoMarkerSet void   
 

Constructor.

SoMarkerSet::~SoMarkerSet   [protected, virtual]
 

Destructor.


Member Function Documentation

void SoMarkerSet::initClass void    [static]
 

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoPointSet.

void SoMarkerSet::GLRender SoGLRenderAction   action [virtual]
 

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoPointSet.

void SoMarkerSet::getPrimitiveCount SoGetPrimitiveCountAction   action [virtual]
 

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoPointSet.

int SoMarkerSet::getNumDefinedMarkers void    [static]
 

Returns the number of defined markers.

void SoMarkerSet::addMarker int    idx,
const SbVec2s   size,
const unsigned char *    bytes,
SbBool    isLSBFirst = TRUE,
SbBool    isUpToDown = TRUE
[static]
 

Replace the bitmap for the marker at idx with the representation given by size dimensions with the bitmap data at bytes. isLSBFirst and isUpToDown indicates how the bitmap data is ordered. Does nothing if markerIndex is NONE.

Here's a complete usage example which demonstrates how to set up a user-specified marker from a char-map:

  const int WIDTH = 18;
  const int HEIGHT = 19;
  const int BYTEWIDTH = (WIDTH + 7) / 2;

  const char coin_marker[WIDTH * HEIGHT + 1] = {
    ".+                "
    "+@.+              "
    " .@#.+            "
    " +$@##.+          "
    "  .%@&##.+        "
    "  +$@&&*##.+      "
    "   .%@&&*=##.+    "
    "   +$@&&&&=-##.+  "
    "    .%@&&&&&-;#&+ "
    "    +$@&&&&&&=#.  "
    "     .%@&&&&*#.   "
    "     +$@&&&&#.    "
    "      .%@&@%@#.   "
    "      +$%@%.$@#.  "
    "       .%%. .$@#. "
    "       +$.   .$>#."
    "        +     .$. "
    "               .  "
    "                  " };

  int byteidx = 0;
  unsigned char bitmapbytes[BYTEWIDTH * HEIGHT];
  for (int h = 0; h < HEIGHT; h++) {
    unsigned char bits = 0;
    for (int w = 0; w < WIDTH; w++) {
      if (coin_marker[(h * WIDTH) + w] != ' ') { bits |= (0x80 >> (w % 8)); }
      if ((((w + 1) % 8) == 0) || (w == WIDTH - 1)) {
        bitmapbytes[byteidx++] = bits;
        bits = 0;
      }
    }
  }

  int MYAPP_ARROW_IDX = SoMarkerSet::getNumDefinedMarkers(); // add at end
  SoMarkerSet::addMarker(MYAPP_ARROW_IDX, SbVec2s(WIDTH, HEIGHT),
                         bitmapbytes, FALSE, TRUE);

This will provide you with an index given by MYAPP_ARROW_IDX which can be used in SoMarkerSet::markerIndex to display the new marker.

SbBool SoMarkerSet::getMarker int    idx,
SbVec2s   size,
const unsigned char *&    bytes,
SbBool &    isLSBFirst
[static]
 

Returns data for marker at idx in the size, bytes and isLSBFirst parameters.

If no marker is defined for given idx, or SoMarkerSet::markerIndex is NONE (not removable), FALSE is returned. If everything is OK, TRUE is returned.

SbBool SoMarkerSet::removeMarker int    idx [static]
 

Removes marker at idx.

If no marker is defined for given idx, or SoMarkerSet::markerIndex is NONE (not removable), FALSE is returned. If everything is OK, TRUE is returned.

SbBool SoMarkerSet::isMarkerBitSet int    idx,
int    bitNumber
[static]
 

Not supported in Coin. Should probably not have been part of the public Open Inventor API.


Member Data Documentation

SoMFInt32 SoMarkerSet::markerIndex
 

Contains the set of index markers to display, defaults to 0 (CROSS_5_5). The special value NONE renders nothing for that marker.


The documentation for this class was generated from the following files:
Generated on Sat May 24 22:39:38 2003 for Coin by doxygen1.2.18