|
| LegendKit (void) |
|
void | preRender (SoAction *action) |
|
void | setImageTransparency (const float transparency=0.0f) |
|
void | useTextureNotImage (const SbBool onoff) |
|
void | setColorCB (uint32_t(*colorCB)(double, void *), void *userdata=NULL) |
|
void | setColorCB (uint32_t(*colorCB)(double)) |
|
void | clearTicks (void) |
|
void | addSmallTick (double nval) |
|
void | addBigTick (double nval, double tickvalue, const SbString *discretestring=NULL) |
|
void | addBigTick (double nval, const SbString &string, const SbString *discretestring=NULL) |
|
void | setDiscreteMode (const SbBool onoff) |
|
void | addDiscreteColor (double uppernval, uint32_t color) |
|
void | addDiscreteColor (double uppernval) |
|
void | clearData (void) |
|
void | enableImage (const SbBool onoff) |
|
float | getLegendWidth (void) const |
|
void | setNumberFormatCallback (SoNumberFormatCB *cb, void *closure) |
|
void | setTickAndLinesColor (const SbColor &color, const float transparency=0.0f) |
|
void | setTextColor (const SbColor &color, const float transparency=0.0f) |
|
void | setPosition (const SbVec2s &pos) |
|
void | setBackgroundColor (const SbColor &color, const float transparency=0.0f) |
|
void | enableBackground (const SbBool onoff) |
|
virtual SoType | getTypeId (void) const |
|
| SoBaseKit (void) |
|
virtual const SoNodekitCatalog * | getNodekitCatalog (void) const |
|
virtual SoNode * | getPart (const SbName &partname, SbBool makeifneeded) |
|
SbString | getPartString (const SoBase *part) |
|
virtual SoNodeKitPath * | createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL) |
|
virtual SbBool | setPart (const SbName &partname, SoNode *from) |
|
SbBool | set (const char *namevaluepairliststring) |
|
SbBool | set (const char *partnamestring, const char *parameterstring) |
|
virtual void | doAction (SoAction *action) |
|
virtual void | write (SoWriteAction *action) |
|
virtual SoChildList * | getChildren (void) const |
|
void | printDiagram (void) |
|
void | printSubDiagram (const SbName &rootname, int level) |
|
void | printTable (void) |
|
virtual void | addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) |
|
SbBool | forceChildDrivenWriteRefs (SoOutput *out) |
|
void | setOverride (const SbBool state) |
|
SbBool | isOverride (void) const |
|
void | setNodeType (const NodeType type) |
|
NodeType | getNodeType (void) const |
|
virtual SoNode * | copy (SbBool copyconnections=FALSE) const |
|
virtual void | GLRenderBelowPath (SoGLRenderAction *action) |
|
virtual void | GLRenderInPath (SoGLRenderAction *action) |
|
virtual void | GLRenderOffPath (SoGLRenderAction *action) |
|
virtual void | grabEventsSetup (void) |
|
virtual void | grabEventsCleanup (void) |
|
virtual void | startNotify (void) |
|
SbUniqueId | getNodeId (void) const |
|
virtual void | writeInstance (SoOutput *out) |
|
virtual SoFieldContainer * | copyThroughConnection (void) const |
|
void | setToDefaults (void) |
|
SbBool | hasDefaultValues (void) const |
|
SbBool | fieldsAreEqual (const SoFieldContainer *container) const |
|
void | copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) |
|
SbBool | set (const char *const fielddata) |
|
void | get (SbString &fielddata) |
|
virtual int | getFields (SoFieldList &l) const |
|
virtual int | getAllFields (SoFieldList &l) const |
|
virtual SoField * | getField (const SbName &name) const |
|
virtual SoField * | getEventIn (const SbName &name) const |
|
virtual SoField * | getEventOut (const SbName &name) const |
|
SbBool | getFieldName (const SoField *const field, SbName &name) const |
|
SbBool | enableNotify (const SbBool flag) |
|
SbBool | isNotifyEnabled (void) const |
|
SbBool | set (const char *fielddata, SoInput *input) |
|
void | get (SbString &fielddata, SoOutput *out) |
|
virtual SbBool | validateNewFieldValue (SoField *field, void *newval) |
|
SbBool | getIsBuiltIn (void) const |
|
virtual void | getFieldsMemorySize (size_t &managed, size_t &unmanaged) const |
|
void | setUserData (void *userdata) const |
|
void * | getUserData (void) const |
|
void | ref (void) const |
|
void | unref (void) const |
|
void | unrefNoDelete (void) const |
|
int32_t | getRefCount (void) const |
|
void | touch (void) |
|
SbBool | isOfType (SoType type) const |
|
virtual SbName | getName (void) const |
|
virtual void | setName (const SbName &newname) |
|
void | addAuditor (void *const auditor, const SoNotRec::Type type) |
|
void | removeAuditor (void *const auditor, const SoNotRec::Type type) |
|
const SoAuditorList & | getAuditors (void) const |
|
SbBool | shouldWrite (void) |
|
void | assertAlive (void) const |
|
|
static void | initClass (void) |
|
static const SoNodekitCatalog * | getClassNodekitCatalog (void) |
|
static SbBool | isSearchingChildren (void) |
|
static void | setSearchingChildren (const SbBool newval) |
|
static uint32_t | getCompatibilityTypes (const SoType &nodetype) |
|
static SoNode * | getByName (const SbName &name) |
|
static int | getByName (const SbName &name, SoNodeList &l) |
|
static void | initClasses (void) |
|
static SbUniqueId | getNextNodeId (void) |
|
static int | getActionMethodIndex (const SoType type) |
|
static void | getBoundingBoxS (SoAction *action, SoNode *node) |
|
static void | GLRenderS (SoAction *action, SoNode *node) |
|
static void | callbackS (SoAction *action, SoNode *node) |
|
static void | getMatrixS (SoAction *action, SoNode *node) |
|
static void | handleEventS (SoAction *action, SoNode *node) |
|
static void | pickS (SoAction *action, SoNode *node) |
|
static void | rayPickS (SoAction *action, SoNode *node) |
|
static void | searchS (SoAction *action, SoNode *node) |
|
static void | writeS (SoAction *action, SoNode *node) |
|
static void | audioRenderS (SoAction *action, SoNode *node) |
|
static void | getPrimitiveCountS (SoAction *action, SoNode *node) |
|
static void | initCopyDict (void) |
|
static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
|
static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
|
static SoFieldContainer * | findCopy (const SoFieldContainer *orig, const SbBool copyconnections) |
|
static void | copyDone (void) |
|
static void | initClass (void) |
|
static SoType | getClassTypeId (void) |
|
static void | addName (SoBase *const base, const char *const name) |
|
static void | removeName (SoBase *const base, const char *const name) |
|
static void | incrementCurrentWriteCounter (void) |
|
static void | decrementCurrentWriteCounter (void) |
|
static SoBase * | getNamedBase (const SbName &name, SoType type) |
|
static int | getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) |
|
static SbBool | read (SoInput *input, SoBase *&base, SoType expectedtype) |
|
static void | setInstancePrefix (const SbString &c) |
|
static void | setTraceRefs (SbBool trace) |
|
static SbBool | getTraceRefs (void) |
|
static SbBool | connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) |
|
static SbBool | readRoute (SoInput *input) |
|
|
virtual void | GLRender (SoGLRenderAction *action) |
|
virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
|
virtual void | handleEvent (SoHandleEventAction *action) |
|
virtual void | search (SoSearchAction *action) |
|
virtual void | callback (SoCallbackAction *action) |
|
virtual void | getMatrix (SoGetMatrixAction *action) |
|
virtual void | pick (SoPickAction *action) |
|
virtual void | rayPick (SoRayPickAction *action) |
|
virtual void | audioRender (SoAudioRenderAction *action) |
|
virtual void | getPrimitiveCount (SoGetPrimitiveCountAction *action) |
|
virtual SbBool | affectsState (void) const |
|
virtual | ~LegendKit () |
|
virtual void | notify (SoNotList *list) |
|
virtual const SoFieldData * | getFieldData (void) const |
|
virtual | ~SoBaseKit () |
|
virtual SoNode * | addToCopyDict (void) const |
|
virtual void | copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) |
|
SoGroup * | getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) |
|
virtual SoNode * | getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) |
|
virtual SoNodeKitPath * | createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) |
|
virtual SbBool | setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) |
|
void | createNodekitPartsList (void) |
|
void | createFieldList (void) |
|
virtual void | createDefaultParts (void) |
|
const SoNodekitParts * | getNodekitPartsList (void) const |
|
const SbList< SoSFNode *> & | getCatalogInstances (void) const |
|
void | catalogError (void) |
|
virtual SbBool | setUpConnections (SbBool onoff, SbBool doitalways=FALSE) |
|
virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
|
virtual void | setDefaultOnNonWritingFields (void) |
|
void | countMyFields (SoOutput *out) |
|
virtual SbBool | setPart (const int partNum, SoNode *node) |
|
| SoNode (void) |
|
virtual | ~SoNode () |
|
| SoFieldContainer (void) |
|
virtual | ~SoFieldContainer () |
|
| SoBase (void) |
|
virtual | ~SoBase () |
|
virtual void | destroy (void) |
|
SbBool | hasMultipleWriteRefs (void) const |
|
SbBool | writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const |
|
void | writeFooter (SoOutput *out) const |
|
virtual const char * | getFileFormatName (void) const |
|
The LegendKit class is used to draw a simple colormap legend.
FIXME: there should be an explanation of general usage here, preferably with an example. 20040305 mortene.
The class is organized as a nodekit for convenience. Most parts are public, but users should seldom have any reason for changing anything but the backgroundMaterial, tickMaterial and extraNodes parts.
This nodekit contains the follwing parts:
- topSeparator The separator that holds all subscene for this kit. Private.
- resetTransform Used to reset any transform that might be on the state
- viewport Used to set the viewport for the legend. Contains a ViewportRegion node. This part is NULL by default. Set this part if you want to restrict the area the legend is drawn into.
- depthBuffer Used to disable depth buffer tests. Contains a DepthBuffer node.
- lightModel Used to disable lighting. Contains an SoLightModel node.
- position Can be used to move the legend from the lower left corner. The coordinate system of this node is one unit per pixel. This part is NULL by default, but a SoTranslation node can be inserted here.
- texture Its only purpose is to disable texturing. Contains an SoTexture2 node.
- shapeHints Contains an SoShapeHints node, and sets default shape hints. This is needed to render the shapes in this kit correctly.
- backgroundMaterial Might be used to change the background color. Contains an SoMaterial node.
- backgroundShape Contains the shape (SoIndexedFaceSet) that renders the background frame. This is rendered as four quads surrounding the image. Set this part to NULL if you don't want a background frame.
- imageSeparator A separator that holds nodes needed to render the image. Private.
- imageTransform Applies a transformation to the image to account for image offset. Will be set in LegendKit::initLegend().
- imageMaterial Is used to reset the material to default before the image is rendered. Contains a default SoMaterial node by default. Will only take effect if you render the image a a textured quad.
- imageSwitch Is used to switch between image rendered as a raw image (whichChild = 0), or rendered as a textured quad (whichChild = 1). This is useful since some 3D hardware might render raw images very slowly. Default value is 0, and you can set this value using Legendkit::useTextureNotImage().
- image Hold the raw image data for the legend as an SoImage node.
- textureGroup A group used to hold the texture image and shape.
- textureImage A one row texture used when rendering the image as a textured quad.
- textureShape An SoFaceSet that renders one quad.
- tickMaterial Can be used to set the material of the ticks and lines. In the default node, diffuse color is set to (0 0 0).
- renderCallbackLines Is used to render ticks and other lines using OpenGL.
- textMaterial Can be used to set the material of the text. This part is NULL by default, and the text will then be rendered in the same color as the ticks and lines.
- renderCallbackText Is used to render text using OpenGL.
- extraNodes Is NULL by default, but can be used to add geometry that can be rendered after all other geometry in this kit. Please note that the coordinate system in the legend is one unit per pixel. This means that the world position (32.0f, 32.0f) is at pixel position (32,32) in the legend viewport.