SoLevelOfSimplification Class Reference

Level-of-detail switching node designed for grouping simplified versions of the same shape. More...

#include <Inventor/nodes/SoLevelOfSimplification.h>

Inheritance diagram for SoLevelOfSimplification:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoLevelOfSimplification ()
	Creates level-of-simplification node with default settings.
	SoLevelOfSimplification (int nChildren)
	Constructor that takes approximate number of children.
Public Member Functions inherited from SoLOD
	SoLOD ()
	Creates a distance-based level-of-detail node with default settings.
	SoLOD (int nChildren)
	Constructor that takes approximate number of children.
Public Member Functions inherited from SoGroup
	SoGroup ()
	Creates an empty group node.
	SoGroup (int nChildren)
	Constructor that takes approximate number of children.
virtual void	addChild (SoNode *child)
	Adds a child as last one in group.
virtual void	insertChild (SoNode *child, int newChildIndex)
	Adds a child so that it becomes the one with the given index.
virtual SoNode *	getChild (int index) const
	Returns pointer the child node with the given index.
virtual int	findChild (const SoNode *child) const
	Finds index of given child within group.
virtual int	getNumChildren () const
	Returns number of children.
virtual void	removeChild (int index)
	Removes child with given index from group.
virtual void	removeChild (SoNode *child)
	Removes first instance of given child from group.
virtual void	removeAllChildren ()
	Removes all children from group.
virtual void	replaceChild (int index, SoNode *newChild)
	Replaces child with given index with new child.
virtual void	replaceChild (SoNode *oldChild, SoNode *newChild)
	Replaces first instance of given child with new child.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoLOD
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoGroup
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoMFFloat	percentages
	Percentage decimation for each child.
SoSFInt32	numTriangles
	Number of triangles in highest (1.0) case.
Public Attributes inherited from SoLOD
SoMFFloat	range
	World-space distances to use as switching criteria.
SoSFVec3f	center
	Object-space center of the model.
Public Attributes inherited from SoGroup
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Level-of-detail switching node designed for grouping simplified versions of the same shape.

This group node is used to group the results of simplifying a shape, such that every child represents the same model but with a different number of primitives. Since it is derived from SoLOD, it can behave as a distance-based level-of-detail node; however, it also responds to the decimation percentage element. It records what percentage decimation each child is, and then chooses the appropriate child based on the DecimationPercentage and DecimationType elements.

You should specify N percentages for N+1 children. If the DecimationType is HIGHEST or LOWEST, then the LevelOfSimplification node will automatically choose the first or last child, respectively. If the DecimationType is PERCENTAGE, then the node will choose child "i" based on the decimation percentage element value such that:

   percentages[i-1] <= DecimationPercentage < percentages[i]

If the DecimationType is AUTOMATIC, then the child is chosen based on the range value in the usual SoLOD manner, but no child greater than the value of the DecimationPercentage element will be chosen.

This node also has a field for recording how many triangles the full detail child contains. This allows this node to answer an SoGetPrimitiveCountAction without traversing its children. This is a benefit when some children contain WWWInline , a common occurrence. If the children contain some non-triangle primitives, then the field should be -1 which will force the node to traverse its children during SoGetPrimitiveCountAction.

FILE FORMAT/DEFAULT

LevelOfSimplification {

percentages	[]
numTriangles	-1
center	0 0 0
range	[ ]

}

ACTION BEHAVIOR

SoGLRenderAction, SoRayPickAction, SoCallbackAction
Only the child with the appropriate level of detail is traversed.

SoGetPrimitiveCountAction
A child is chosen in the same way as in GLRender. If the numTriangles field is greater than 0, the percentage value for this child is multiplied by the numTriangles value and this value is added to the PrimitiveCount without traversing the child. If numTriangles is less than or equal to 0, then the child is traversed to get the count.

Other actions

Implemented as for SoGroup

SEE ALSO

SoGetPrimitiveCountAction, SoLOD, SoOctreeOrdering, SoRenderList, SoValueOrdering SoLevelOfDetail

Definition at line 140 of file SoLevelOfSimplification.h.

Constructor & Destructor Documentation

SoLevelOfSimplification() [1/2]

SoLevelOfSimplification::SoLevelOfSimplification

(

)

Creates level-of-simplification node with default settings.

SoLevelOfSimplification() [2/2]

SoLevelOfSimplification::SoLevelOfSimplification

(

int

nChildren

)

Constructor that takes approximate number of children.

Member Function Documentation

getClassTypeId()

static SoType SoLevelOfSimplification::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoLevelOfSimplification::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoLOD.

Member Data Documentation

numTriangles

SoSFInt32 SoLevelOfSimplification::numTriangles

Number of triangles in highest (1.0) case.

Can be -1 if unknown or if children contain primitives other than triangles.

Definition at line 157 of file SoLevelOfSimplification.h.

percentages

SoMFFloat SoLevelOfSimplification::percentages

Percentage decimation for each child.

Should be numbers between 0.0 and 1.0, with 1.0 representing full detail and 0.0 representing bounding box detail.

Definition at line 151 of file SoLevelOfSimplification.h.

---

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

• Inventor/nodes/SoLevelOfSimplification.h