The SmAxisDisplayKit is used to draw colored and annotated axes in the lower right corner of the display. More...

#include <SmAxisDisplayKit.h>

Public Member Functions
	SmAxisDisplayKit (void)

virtual void	GLRender (SoGLRenderAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *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)

Public Member Functions inherited from SoBaseKit
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)

Public Member Functions inherited from SoNode
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

Public Member Functions inherited from SoFieldContainer
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

Public Member Functions inherited from SoBase
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 Public Member Functions
static void	initClass (void)

Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCatalog *	getClassNodekitCatalog (void)

static SbBool	isSearchingChildren (void)

static void	setSearchingChildren (const SbBool newval)

Static Public Member Functions inherited from SoNode
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 Public Member Functions inherited from SoFieldContainer
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 Public Member Functions inherited from SoBase
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)

Public Attributes
SoSFRotation	orientation

SoMFVec3f	axes

SoMFColor	colors

SoMFBool	enableArrows

SoMFString	annotations

SoSFBool	headlight

Public Attributes inherited from SoNode
	INVENTOR

	VRML1

	VRML2

	INVENTOR_1

	INVENTOR_2_0

	INVENTOR_2_1

	INVENTOR_2_5

	INVENTOR_2_6

	COIN_1_0

	COIN_2_0

	EXTENSION

Protected Member Functions
virtual	~SmAxisDisplayKit ()

virtual void	notify (SoNotList *l)

virtual void	setDefaultOnNonWritingFields (void)

virtual SbBool	affectsState (void) const

Protected Member Functions inherited from SoBaseKit
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)

void	countMyFields (SoOutput *out)

virtual SbBool	setPart (const int partNum, SoNode *node)

Protected Member Functions inherited from SoNode
	SoNode (void)

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	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

Additional Inherited Members
Public Types inherited from SoNode
enum	NodeType

Protected Types inherited from SoBase
enum	BaseFlags

Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)

static void	setNextActionMethodIndex (int index)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

Protected Attributes inherited from SoBaseKit
SoChildList *	children

SbBool	connectionsSetUp

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId

static int	nextActionMethodIndex

Detailed Description

The SmAxisDisplayKit is used to draw colored and annotated axes in the lower right corner of the display.

This class is organized as a nodekit, but should be used as a normal node (i.e. use public fields).

Constructor & Destructor Documentation

◆ SmAxisDisplayKit()

SmAxisDisplayKit::SmAxisDisplayKit ( void )

Constructor.

◆ ~SmAxisDisplayKit()

SmAxisDisplayKit::~SmAxisDisplayKit ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ affectsState()

SbBool SmAxisDisplayKit::affectsState ( void ) const

protectedvirtual

Reimplemented from SoNode.

◆ audioRender()

void SmAxisDisplayKit::audioRender ( SoAudioRenderAction * action )

virtual

Reimplemented from SoNode.

◆ callback()

void SmAxisDisplayKit::callback ( SoCallbackAction * action )

virtual

Reimplemented from SoBaseKit.

◆ getBoundingBox()

void SmAxisDisplayKit::getBoundingBox ( SoGetBoundingBoxAction * action )

virtual

Reimplemented from SoBaseKit.

◆ getMatrix()

void SmAxisDisplayKit::getMatrix ( SoGetMatrixAction * action )

virtual

Reimplemented from SoBaseKit.

◆ getPrimitiveCount()

void SmAxisDisplayKit::getPrimitiveCount ( SoGetPrimitiveCountAction * action )

virtual

Reimplemented from SoBaseKit.

◆ GLRender()

void SmAxisDisplayKit::GLRender ( SoGLRenderAction * action )

virtual

Overloaded to perform delayed rendering and to force solid rendering mode.

Reimplemented from SoBaseKit.

◆ handleEvent()

void SmAxisDisplayKit::handleEvent ( SoHandleEventAction * action )

virtual

Reimplemented from SoBaseKit.

◆ initClass()

void SmAxisDisplayKit::initClass ( void )

static

Initializes this class. Call before using it.

◆ notify()

void SmAxisDisplayKit::notify ( SoNotList * l )

protectedvirtual

Overloaded to detect when fields changes in order to correctly regenerate the private scene graph.

Reimplemented from SoNode.

◆ pick()

void SmAxisDisplayKit::pick ( SoPickAction * action )

virtual

Reimplemented from SoNode.

◆ rayPick()

void SmAxisDisplayKit::rayPick ( SoRayPickAction * action )

virtual

Reimplemented from SoBaseKit.

◆ search()

void SmAxisDisplayKit::search ( SoSearchAction * action )

virtual

Reimplemented from SoBaseKit.

◆ setDefaultOnNonWritingFields()

void SmAxisDisplayKit::setDefaultOnNonWritingFields ( void )

protectedvirtual

Overloaded to set most node fields to default. The parts in this nodekit are mostly internal.

Reimplemented from SoBaseKit.

Member Data Documentation

◆ annotations

SoMFString SmAxisDisplayKit::annotations

Specifies annotation for each axis. The annotation will be rendered as a SoText2 node. If not enough values are given, no annotations will be displayed for the remaining axes.

Default value is empty.

◆ axes

SoMFVec3f SmAxisDisplayKit::axes

Specifies which axes to display. The given axes are displayed as vectors originating in origo.

Default value is empty.

◆ colors

SoMFColor SmAxisDisplayKit::colors

Specifies which colors the axes should be drawn with. If not enough values are given, the last value will be reused for the remaining axes.

Default value is white - SbColor(1.0f, 1.0f, 1.0f).

◆ enableArrows

SoMFBool SmAxisDisplayKit::enableArrows

Specifies whether arrows should be displayed at the end of each axis. If not enough values are given, the last value will be reused for the remaining axes.

Default value is TRUE.

◆ headlight

SoSFBool SmAxisDisplayKit::headlight

◆ orientation

SoSFRotation SmAxisDisplayKit::orientation

Specifies the orientation of the axes. This field should normally be connected to the current camera's orientation field.

Default value is as for SoCamera::orientation.

The documentation for this class was generated from the following files:

C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodekits/SmAxisDisplayKit.h
C:/Data/Volker/Bitbucket/smallchange/lib/SmallChange/nodekits/SmAxisDisplayKit.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SmAxisDisplayKit()

◆ ~SmAxisDisplayKit()

Member Function Documentation

◆ affectsState()

◆ audioRender()

◆ callback()

◆ getBoundingBox()

◆ getMatrix()

◆ getPrimitiveCount()

◆ GLRender()

◆ handleEvent()

◆ initClass()

◆ notify()

◆ pick()

◆ rayPick()

◆ search()

◆ setDefaultOnNonWritingFields()

Member Data Documentation

◆ annotations

◆ axes

◆ colors

◆ enableArrows

◆ headlight

◆ orientation