SoIndexedShape Class Reference

Abstract base class for all indexed vertex-based shapes. More...

#include <Inventor/nodes/SoIndexedShape.h>

Inheritance diagram for SoIndexedShape:

Fields
SoMFInt32	coordIndex
	The indices of the coordinates that the shape uses as its vertices.
SoMFInt32	materialIndex
	Material indices.
SoMFInt32	normalIndex
	Surface normal indices.
SoMFInt32	textureCoordIndex
	Texture Coordinate indices.
static void	initClass ()
	SoIndexedShape ()
	Constructor - makes this abstract.
virtual void	computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
	This handles bounding box computation for all shapes derived from this class.
int	getNumVerts (int startCoord)
	Starting at a given index in the coordIndex array, figure out how many vertices there are before either the end of the array or the next 'border' index.
void	setupIndices (int numParts, int numFaces, bool needNormals, bool needTexCoords)
	Setup for fast rendering.
const int32_t *	getNormalIndices ()
	These must not be called unless setupIndices has been called first:
const int32_t *	getColorIndices ()
const int32_t *	getTexCoordIndices ()
virtual void	notify (SoNotList *list)
	Keep indices up to date if things change.
virtual	~SoIndexedShape ()
static bool	areTexCoordsIndexed (SoAction *action)
	Returns TRUE if texture coordinates should be indexed.

Additional Inherited Members
Public Types inherited from SoShape
enum	TriangleShape { TRIANGLE_STRIP , TRIANGLE_FAN , TRIANGLES , POLYGON }
	This type is used by the triangle shape generation methods (beginShape, etc.) More...
typedef void	VertexArrayRenderingCB(SoNode *shape, SoGLRenderAction *, bool useVbo, uint32_t numVertices)
	callback used for pre/post vertex array rendering on SoVertexShapes (MeVis ONLY)
Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
Public Member Functions inherited from SoVertexShape
virtual bool	generateDefaultNormals (SoState *state, SoNormalBundle *nb)
	Subclasses may define this method to generate normals to use when the normal binding is DEFAULT and there aren't enough normals in the state.
virtual void	notify (SoNotList *list)
	Redefines this to invalidate normal cache.
Public Member Functions inherited from SoShape
virtual bool	affectsState () const
	Overrides default method on SoNode.
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
	Implements bounding box method using virtual computeBBox() method.
virtual void	GLRender (SoGLRenderAction *action)
	Implements rendering by rendering each primitive generated by subclass.
virtual void	rayPick (SoRayPickAction *action)
	Implements picking along a ray by intersecting the ray with each primitive generated by subclass.
virtual void	callback (SoCallbackAction *action)
	Implements primitive generation for all shapes.
virtual void	computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)=0
	Computes bounding box for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction).
Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off.
bool	isOverride () const
	Returns the state of the override flag.
SoNode *	copy (bool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual bool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.
virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
virtual void	callback (SoCallbackAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	pick (SoPickAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
virtual void	write (SoWriteAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
virtual void	grabEventsSetup ()
	These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).
virtual void	grabEventsCleanup ()
virtual void	startNotify ()
	Initiates notification from an instance.
virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.
SbNodeIdType	getNodeId () const
	Returns the unique id for a node.
virtual SoChildList *	getChildren () const
	Returns pointer to children, or NULL if none.
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.)
virtual SoNode *	addToCopyDict () const
	Recursively adds this node and all nodes under it to the copy dictionary.
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.
virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
bool	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 Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.
bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
bool	set (const char *fieldDataString, SoInput *dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
virtual void	notify (SoNotList *)
	Propagates modification notification through an instance.
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)
bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.
virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.
virtual SoFieldContainer *	copyThroughConnection () const
	During a copy operation, this copies an instance that is encountered through a field connection.
void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.
Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance.
void	unref () const
void	unrefNoDelete () const
void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.
bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
virtual void	startNotify ()
	Initiates notification from an instance.
virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.
void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.
void	removeAuditor (void *auditor, SoNotRec::Type type)
const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
int	getRefCount () const
	Returns current reference count.
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.
bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.
Static Public Member Functions inherited from SoVertexShape
static void	initClass ()
Static Public Member Functions inherited from SoShape
static void	initClass ()
static void	getScreenSize (SoState *state, const SbBox3f &boundingBox, SbVec2s &rectSize)
	This can be used by subclasses when the complexity type is SCREEN_SPACE to determine how many window pixels are covered by the shape.
static void	setPreVertexArrayRenderingCallback (VertexArrayRenderingCB *cb)
	register global pre callback for vertex array rendering (MeVis ONLY)
static void	setPostVertexArrayRenderingCallback (VertexArrayRenderingCB *cb)
	register global post callback for vertex array rendering (MeVis ONLY)
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns type identifier for the SoNode class.
static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name.
static int	getByName (const SbName &name, SoNodeList &list)
	Returns the number of nodes with the given name, and adds to list pointers to those nodes.
static void	initClass ()
	Initializes base node class.
static void	initClasses ()
	Initialize ALL Inventor node classes.
static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id.
static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
static void	initClass ()
	Setup type information.
static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.
static void	addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
	Adds an instance to the dictionary.
static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.
static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.
static void	copyDone ()
	Cleans up the dictionary when done.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
static void	initClass ()
	Setup type information.
static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.
static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.
static void	addName (SoBase *, const char *)
	Internal methods used to maintain the global name dictionary.
static void	removeName (SoBase *, const char *)
static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.
static int	getNamedBases (const SbName &, SoBaseList &, SoType)
static bool	read (SoInput *in, SoBase *&base, SoType expectedType)
	Reads one instance of some subclass of SoBase.
static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.
Public Attributes inherited from SoVertexShape
SoSFNode	vertexProperty
Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...
Protected Member Functions inherited from SoVertexShape
	SoVertexShape ()
	Constructor - makes this abstract.
virtual	~SoVertexShape ()
SoVertexProperty *	getVertexProperty ()
	Get the SoVertexProperty from the vertexProperty field, returning NULL if the contained node is not of type SoVertexProperty.
virtual bool	shouldGLRender (SoGLRenderAction *action)
	Returns TRUE if the shape should be rendered.
void	setNormalCache (SoState *state, int numNormals, const SbVec3f *normals)
	Sets up a cache to hold normals.
SoNormalCache *	getNormalCache () const
	Returns the current normal cache, or NULL if there is none.
bool	beginVertexArrayRendering (SoGLRenderAction *action)
	enables vertex array rendering client state and VBO rendering (if supported), returns true if VBOs are used (MeVis ONLY)
void	endVertexArrayRendering (SoGLRenderAction *action, bool vboWasUsed)
	disables vertex array rendering and VBOs if vboWasUsed is passes as true (MeVis ONLY)
Protected Member Functions inherited from SoShape
	SoShape ()
	Constructor.
virtual void	generatePrimitives (SoAction *action)=0
	This method MUST be defined by each subclass to generate primitives (triangles, line segments, points) that represent the shape.
virtual bool	shouldGLRender (SoGLRenderAction *action)
	Returns TRUE if the shape should be rendered.
bool	shouldRayPick (SoRayPickAction *action)
	Returns TRUE if the shape may be picked.
void	beginSolidShape (SoGLRenderAction *action)
	These can be used by solid shapes to indicate so during rendering.
void	endSolidShape (SoGLRenderAction *action)
void	computeObjectSpaceRay (SoRayPickAction *action)
	Computes a picking ray in the object space of the shape instance.
void	computeObjectSpaceRay (SoRayPickAction *action, const SbMatrix &matrix)
virtual SoDetail *	createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
	These methods are called during picking to create details representing extra info about a pick intersection.
virtual SoDetail *	createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp)
virtual SoDetail *	createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp)
void	invokeTriangleCallbacks (SoAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3)
	These methods invoke whatever callbacks are registered with the primitive generation procedures.
void	invokeLineSegmentCallbacks (SoAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2)
void	invokePointCallbacks (SoAction *action, const SoPrimitiveVertex *v)
void	beginShape (SoAction *action, TriangleShape shapeType, SoFaceDetail *faceDetail=NULL)
	These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type.
void	shapeVertex (const SoPrimitiveVertex *v)
void	endShape ()
virtual	~SoShape ()
void	GLRenderBoundingBox (SoGLRenderAction *action)
	Applies GLRender action to the bounding box surrounding the shape.
Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor.
virtual	~SoNode ()
Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()
	~SoFieldContainer ()
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.
Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.
virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.
virtual void	destroy ()
	Actually deletes an instance.
bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.
bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
void	writeFooter (SoOutput *out) const
virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)
virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.
Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros.
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.
Protected Attributes inherited from SoVertexShape
SoVertexPropertyCache	vpCache
	vpCache stores information from one render to the next about what information needs to be grabbed from the state, etc.
Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node.
Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.
Static Protected Attributes inherited from SoShape
static VertexArrayRenderingCB *	_preVertexArrayRenderingCB
static VertexArrayRenderingCB *	_postVertexArrayRenderingCB
Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id.
static int	nextActionMethodIndex
	Next index into the action method table.

Detailed Description

This node is the abstract base class for all vertex-based shapes that are constructed from indices, including SoIndexedFaceSet, SoIndexedTriangleStripSet, and SoIndexedLineSet. SoIndexedShape defines fields that are used in all of its subclasses.

All subclasses of SoNonIndexedShape construct objects by using the coordinates specified by the vertexProperty field (from SoVertexShape), or the current inherited coordinates. The coordIndex field defined by this class contains the indices into the current coordinates of the vertices of the shape. These indices are also used for materials, normals, or texture coordinates when the appropriate binding is PER_VERTEX_INDEXED.

Material and normal bindings are interpreted as follows for each subclass:

OVERALL         One material for the entire shape.
PER_PART                Specific to the subclass.
PER_PART_INDEXED        Same as PER_PART, using indices from the
                        materialIndex or normalIndex field.
PER_FACE                Specific to the subclass.
PER_FACE_INDEXED        Same as PER_FACE, using indices from the
                        materialIndex or normalIndex field.
PER_VERTEX              One material per vertex.
PER_VERTEX_INDEXED      One material per vertex, using indices from the
                        materialIndex or normalIndex field.

When any _INDEXED binding is used for materials or normals, the materialIndex or normalIndex field is used to determine the indices for the materials or normals. If this field contains a single value of -1 (the default), the coordinate indices from the coordIndex field are used as well for materials or normals. When the binding is PER_VERTEX_INDEXED, indices in these fields that correspond to negative indices in coordIndex are skipped; for other index bindings all the values in the fields are used, in order.

Explicit texture coordinates (as defined by SoTextureCoordinate2) may be bound to vertices of an indexed shape consecutively (if the texture coordinate binding is PER_VERTEX) or by using the indices in the textureCoordIndex field (if the binding is PER_VERTEX_INDEXED). As with all vertex-based shapes, if there is a current texture but no texture coordinates are specified, a default texture coordinate mapping is calculated using the bounding box of the shape.

Be sure that the indices contained in the coordIndex , materialIndex , normalIndex , and textureCoordIndex fields are valid with respect to the current state, or errors will occur.

See Also

SoIndexedFaceSet, SoIndexedTriangleSet, SoIndexedLineSet, SoIndexedTriangleStripSet, SoMaterialBinding, SoNonIndexedShape, SoNormalBinding, SoShapeHints, SoTextureCoordinateBinding

Definition at line 129 of file SoIndexedShape.h.

Constructor & Destructor Documentation

SoIndexedShape()

SoIndexedShape::SoIndexedShape ( )

protected

~SoIndexedShape()

virtual SoIndexedShape::~SoIndexedShape ( )

protectedvirtual

Member Function Documentation

areTexCoordsIndexed()

static bool SoIndexedShape::areTexCoordsIndexed ( SoAction *  action )

staticprotected

computeBBox()

virtual void SoIndexedShape::computeBBox ( SoAction *  action, SbBox3f &  box, SbVec3f &  center  )

protectedvirtual

It sets the bounding box to contain all vertices of the shape, assuming that the shape uses the coordinates indexed by all non-negative values in the coordIndex field. It also sets the center to the average of the vertices' coordinates.

Implements SoShape.

getColorIndices()

const int32_t * SoIndexedShape::getColorIndices ( )

inlineprotected

Definition at line 186 of file SoIndexedShape.h.

getNormalIndices()

const int32_t * SoIndexedShape::getNormalIndices ( )

inlineprotected

Definition at line 184 of file SoIndexedShape.h.

getNumVerts()

int SoIndexedShape::getNumVerts ( int  startCoord )

protected

getTexCoordIndices()

const int32_t * SoIndexedShape::getTexCoordIndices ( )

inlineprotected

Definition at line 188 of file SoIndexedShape.h.

initClass()

static void SoIndexedShape::initClass ( )

static

notify()

virtual void SoIndexedShape::notify ( SoNotList *  list )

protectedvirtual

Reimplemented from SoVertexShape.

setupIndices()

void SoIndexedShape::setupIndices ( int  numParts, int  numFaces, bool  needNormals, bool  needTexCoords  )

protected

This should be called by subclasses, which can then use the textureI/colorI/normalI arrays (which will either point to one of the coordIndex arrays, or to a consective array of integers. This must be called AFTER the vpCache has been filled in.

Member Data Documentation

coordIndex

SoMFInt32 SoIndexedShape::coordIndex

The coordinates connect to form faces, lines, or other shapes. Each subclass defines special negative indices to use to indicate separation between faces, lines, and so on.

Definition at line 141 of file SoIndexedShape.h.

materialIndex

SoMFInt32 SoIndexedShape::materialIndex

Definition at line 143 of file SoIndexedShape.h.

normalIndex

SoMFInt32 SoIndexedShape::normalIndex

Definition at line 145 of file SoIndexedShape.h.

textureCoordIndex

SoMFInt32 SoIndexedShape::textureCoordIndex

Definition at line 147 of file SoIndexedShape.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoIndexedShape.h