Abstract base class for all shape nodes. More...

#include <Inventor/nodes/SoShape.h>

Inheritance diagram for SoShape:

Classes
struct	SimpleVertexArrayCache
	Helper struct used by primitive types like cube, sphere, ... More...

Public Types
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) More...

Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }

Public Member Functions
virtual bool	affectsState () const
	Overrides default method on SoNode. More...

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
	Implements bounding box method using virtual computeBBox() method. More...

virtual void	GLRender (SoGLRenderAction *action)
	Implements rendering by rendering each primitive generated by subclass. More...

virtual void	rayPick (SoRayPickAction *action)
	Implements picking along a ray by intersecting the ray with each primitive generated by subclass. More...

virtual void	callback (SoCallbackAction *action)
	Implements primitive generation for all shapes. More...

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). More...

Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off. More...

bool	isOverride () const
	Returns the state of the override flag. More...

SoNode *	copy (bool copyConnections=FALSE) const
	Creates and returns an exact copy of the node. More...

virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action. More...

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *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. More...

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()). More...

virtual void	grabEventsCleanup ()

virtual void	startNotify ()
	Initiates notification from an instance. More...

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance. More...

SbNodeIdType	getNodeId () const
	Returns the unique id for a node. More...

virtual SoChildList *	getChildren () const
	Returns pointer to children, or NULL if none. More...

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.) More...

virtual SoNode *	addToCopyDict () const
	Recursively adds this node and all nodes under it to the copy dictionary. More...

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance. More...

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection. More...

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values. More...

bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values. More...

bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to `fc's` fields. More...

void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of `fc's` fields into this object's fields. More...

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. More...

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...

virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name. More...

bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the `fieldName` argument. More...

bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...

bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed. More...

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. More...

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. More...

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing. More...

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library. More...

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node. More...

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container. More...

Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance. More...

void	unref () const

void	unrefNoDelete () const

void	touch ()
	Marks an instance as modified, simulating a change to it. More...

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance. More...

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type. More...

virtual SbName	getName () const
	Returns the name of an instance. More...

virtual void	setName (const SbName &name)
	Sets the name of an instance. More...

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list. More...

void	removeAuditor (void *auditor, SoNotRec::Type type)

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...

int	getRefCount () const
	Returns current reference count. More...

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...

Static Public Member Functions
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. More...

static void	setPreVertexArrayRenderingCallback (VertexArrayRenderingCB *cb)
	register global pre callback for vertex array rendering (MeVis ONLY) More...

static void	setPostVertexArrayRenderingCallback (VertexArrayRenderingCB *cb)
	register global post callback for vertex array rendering (MeVis ONLY) More...

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns type identifier for the SoNode class. More...

static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name. More...

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. More...

static void	initClass ()
	Initializes base node class. More...

static void	initClasses ()
	Initialize ALL Inventor node classes. More...

static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id. More...

static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type. More...

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class. More...

static void	initClass ()
	Setup type information. More...

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. More...

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary. More...

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it. More...

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL. More...

static void	copyDone ()
	Cleans up the dictionary when done. More...

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class. More...

static void	initClass ()
	Setup type information. More...

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation. More...

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases. More...

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary. More...

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict. More...

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase. More...

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...

Protected Member Functions
	SoShape ()
	Constructor. More...

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. More...

virtual bool	shouldGLRender (SoGLRenderAction *action)
	Returns TRUE if the shape should be rendered. More...

bool	shouldRayPick (SoRayPickAction *action)
	Returns TRUE if the shape may be picked. More...

void	beginSolidShape (SoGLRenderAction *action)
	These can be used by solid shapes to indicate so during rendering. More...

void	endSolidShape (SoGLRenderAction *action)

void	computeObjectSpaceRay (SoRayPickAction *action)
	Computes a picking ray in the object space of the shape instance. More...

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. More...

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. More...

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. More...

void	shapeVertex (const SoPrimitiveVertex *v)

void	endShape ()

virtual	~SoShape ()

void	GLRenderBoundingBox (SoGLRenderAction *action)
	Applies GLRender action to the bounding box surrounding the shape. More...

Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor. More...

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. More...

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class. More...

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly. More...

virtual void	destroy ()
	Actually deletes an instance. More...

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references. More...

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...

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) More...

Static Protected Attributes
static VertexArrayRenderingCB *	_preVertexArrayRenderingCB

static VertexArrayRenderingCB *	_postVertexArrayRenderingCB

Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id. More...

static int	nextActionMethodIndex
	Next index into the action method table. More...

Additional Inherited Members
Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging) More...

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...

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter. More...

Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node. More...

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. More...

Detailed Description

This node is the abstract base class for all shape (geometry) nodes. All classes derived from SoShape draw geometry during render traversal.

See Also

: SoCone, SoCube, SoCylinder, SoIndexedNurbsCurve, SoIndexedNurbsSurface, SoNurbsCurve, SoNurbsSurface, SoShapeHints, SoShapeKit, SoSphere, SoText2, SoText3, SoVertexShape

Definition at line 101 of file SoShape.h.

Member Typedef Documentation

◆ VertexArrayRenderingCB

typedef void SoShape::VertexArrayRenderingCB(SoNode *shape, SoGLRenderAction *, bool useVbo, uint32_t numVertices)

Definition at line 157 of file SoShape.h.

Member Enumeration Documentation

◆ TriangleShape

enum SoShape::TriangleShape

Enumerator
TRIANGLE_STRIP
TRIANGLE_FAN
TRIANGLES
POLYGON

Definition at line 114 of file SoShape.h.

Constructor & Destructor Documentation

◆ SoShape()

SoShape::SoShape ( )

protected

◆ ~SoShape()

virtual SoShape::~SoShape ( )

protectedvirtual

Member Function Documentation

◆ affectsState()

virtual bool SoShape::affectsState ( ) const

virtual

Reimplemented from SoNode.

◆ beginShape()

void SoShape::beginShape	(	SoAction *	action,
		TriangleShape	shapeType,
		SoFaceDetail *	faceDetail = `NULL`
	)

protected

The sequence of calls is similar to GL's: begin a shape, send vertices of that shape, then end the shape.

If the face detail passed to beginShape() is NULL (the default), the details in the vertices will be used as is. Note that some vertices may be copied into local storage; the detail pointers are copied as well, so the details themselves should be consistent for the duration of the shape generation.

If the face detail passed to beginShape() is non-NULL, the details in the vertices are assumed to be SoPointDetails. Each vertex of each triangle generated will contain a pointer to the face detail, which will be filled with three copies of the point details from the relevant vertices. Since copies of the point details are made, the storage for each point detail passed to shapeVertex() can be re-used by the caller.

◆ beginSolidShape()

void SoShape::beginSolidShape ( SoGLRenderAction * action )

protected

They take care of setting up shape hints in the state. Calls to these two methods should bracket the rendering code.

◆ callback()

virtual void SoShape::callback ( SoCallbackAction * action )

virtual

Calls the generatePrimitives for the shape.

Reimplemented from SoNode.

◆ computeBBox()

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

pure virtual

This is used by getBoundingBox() and when rendering or picking a shape with bounding-box complexity. Subclasses must define this method.

Implemented in SoTriangleStripSet, SoText3, SoText2, SoSphere, SoQuadMesh, SoPointSet, SoNurbsSurface, SoNurbsCurve, SoLineSet, SoIndexedShape, SoIndexedNurbsSurface, SoIndexedNurbsCurve, SoFaceSet, SoCylinder, SoCube, SoCone, and SoAsciiText.

◆ computeObjectSpaceRay() [1/2]

void SoShape::computeObjectSpaceRay ( SoRayPickAction * action )

protected

The picking ray is stored in the SoRayPickAction for later access by the subclass. The second form takes a matrix to concatenate with the current transformation matrix. It can be used, for example, if a shape has sizing or positioning info built into it.

◆ computeObjectSpaceRay() [2/2]

void SoShape::computeObjectSpaceRay	(	SoRayPickAction *	action,
		const SbMatrix &	matrix
	)

protected

◆ createLineSegmentDetail()

virtual SoDetail* SoShape::createLineSegmentDetail	(	SoRayPickAction *	action,
		const SoPrimitiveVertex *	v1,
		const SoPrimitiveVertex *	v2,
		SoPickedPoint *	pp
	)

protectedvirtual

Reimplemented in SoLineSet, and SoIndexedLineSet.

◆ createPointDetail()

virtual SoDetail* SoShape::createPointDetail	(	SoRayPickAction *	action,
		const SoPrimitiveVertex *	v,
		SoPickedPoint *	pp
	)

protectedvirtual

Reimplemented in SoPointSet.

◆ createTriangleDetail()

virtual SoDetail* SoShape::createTriangleDetail	(	SoRayPickAction *	action,
		const SoPrimitiveVertex *	v1,
		const SoPrimitiveVertex *	v2,
		const SoPrimitiveVertex *	v3,
		SoPickedPoint *	pp
	)

protectedvirtual

The default methods implemented in SoShape return NULL. Subclasses can override these methods to set up specific detail instances that contain the extra info. Subclasses can get whatever information they need from the SoPickedPoint, and can set information in it as well.

Reimplemented in SoTriangleStripSet, SoQuadMesh, SoIndexedTriangleStripSet, SoIndexedTriangleSet, SoIndexedFaceSet, SoFaceSet, and SoCube.

◆ endShape()

void SoShape::endShape ( )

protected

◆ endSolidShape()

void SoShape::endSolidShape ( SoGLRenderAction * action )

protected

◆ generatePrimitives()

virtual void SoShape::generatePrimitives ( SoAction * action )

protectedpure virtual

◆ getBoundingBox()

virtual void SoShape::getBoundingBox ( SoGetBoundingBoxAction * action )

virtual

Subclasses should not need to override this.

Reimplemented from SoNode.

Reimplemented in SoPointSet, SoNurbsCurve, SoLineSet, SoIndexedNurbsCurve, and SoIndexedLineSet.

◆ getScreenSize()

static void SoShape::getScreenSize	(	SoState *	state,
		const SbBox3f &	boundingBox,
		SbVec2s &	rectSize
	)

static

It returns in rectSize the number of pixels in the window rectangle that covers the given 3D bounding box.

◆ GLRender()

virtual void SoShape::GLRender ( SoGLRenderAction * action )

virtual

May be overridden in subclass.

Reimplemented from SoNode.

Reimplemented in SoTriangleStripSet, SoText3, SoText2, SoSphere, SoQuadMesh, SoPointSet, SoNurbsSurface, SoNurbsCurve, SoLineSet, SoIndexedTriangleStripSet, SoIndexedTriangleSet, SoIndexedNurbsSurface, SoIndexedNurbsCurve, SoIndexedLineSet, SoIndexedFaceSet, SoFaceSet, SoCylinder, SoCube, SoCone, and SoAsciiText.

◆ GLRenderBoundingBox()

void SoShape::GLRenderBoundingBox ( SoGLRenderAction * action )

protected

This is used to render shapes when BOUNDING_BOX complexity is on.

◆ initClass()

static void SoShape::initClass ( )

static

◆ invokeLineSegmentCallbacks()

void SoShape::invokeLineSegmentCallbacks	(	SoAction *	action,
		const SoPrimitiveVertex *	v1,
		const SoPrimitiveVertex *	v2
	)

protected

◆ invokePointCallbacks()

void SoShape::invokePointCallbacks	(	SoAction *	action,
		const SoPrimitiveVertex *	v
	)

protected

◆ invokeTriangleCallbacks()

void SoShape::invokeTriangleCallbacks	(	SoAction *	action,
		const SoPrimitiveVertex *	v1,
		const SoPrimitiveVertex *	v2,
		const SoPrimitiveVertex *	v3
	)

protected

If primitives are being generated for picking or rendering purposes, the appropriate SoShape methods are called. If primitives are being generated for the SoCallbackAction, the callbacks registered with the action are called.

◆ rayPick()

virtual void SoShape::rayPick ( SoRayPickAction * action )

virtual

May be overridden in subclass.

Reimplemented from SoNode.

Reimplemented in SoText3, SoText2, SoSphere, SoNurbsSurface, SoNurbsCurve, SoIndexedNurbsSurface, SoIndexedNurbsCurve, SoCylinder, SoCube, SoCone, and SoAsciiText.

◆ setPostVertexArrayRenderingCallback()

static void SoShape::setPostVertexArrayRenderingCallback ( VertexArrayRenderingCB * cb )

static

◆ setPreVertexArrayRenderingCallback()

static void SoShape::setPreVertexArrayRenderingCallback ( VertexArrayRenderingCB * cb )

static

◆ shapeVertex()

void SoShape::shapeVertex ( const SoPrimitiveVertex * v )

protected

◆ shouldGLRender()

virtual bool SoShape::shouldGLRender ( SoGLRenderAction * action )

protectedvirtual

Subclasses can call this in their rendering methods to determine whether to continue.

Reimplemented in SoVertexShape.

◆ shouldRayPick()

bool SoShape::shouldRayPick ( SoRayPickAction * action )

protected

Subclasses can call this in their picking methods to determine whether to continue.

Member Data Documentation

◆ _postVertexArrayRenderingCB

VertexArrayRenderingCB* SoShape::_postVertexArrayRenderingCB

staticprotected

Definition at line 366 of file SoShape.h.

◆ _preVertexArrayRenderingCB

VertexArrayRenderingCB* SoShape::_preVertexArrayRenderingCB

staticprotected

Definition at line 365 of file SoShape.h.

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

/home/jenkins/workspaces/mevislab/4.1.1_0/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoShape.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ VertexArrayRenderingCB

Member Enumeration Documentation

◆ TriangleShape

Constructor & Destructor Documentation

◆ SoShape()

◆ ~SoShape()

Member Function Documentation

◆ affectsState()

◆ beginShape()

◆ beginSolidShape()

◆ callback()

◆ computeBBox()

◆ computeObjectSpaceRay() [1/2]

◆ computeObjectSpaceRay() [2/2]

◆ createLineSegmentDetail()

◆ createPointDetail()

◆ createTriangleDetail()

◆ endShape()

◆ endSolidShape()

◆ generatePrimitives()

◆ getBoundingBox()

◆ getScreenSize()

◆ GLRender()

◆ GLRenderBoundingBox()

◆ initClass()

◆ invokeLineSegmentCallbacks()

◆ invokePointCallbacks()

◆ invokeTriangleCallbacks()

◆ rayPick()

◆ setPostVertexArrayRenderingCallback()

◆ setPreVertexArrayRenderingCallback()

◆ shapeVertex()

◆ shouldGLRender()

◆ shouldRayPick()

Member Data Documentation

◆ _postVertexArrayRenderingCB

◆ _preVertexArrayRenderingCB