Indexed polyline shape node. More...

#include <Inventor/nodes/SoIndexedLineSet.h>

Inheritance diagram for SoIndexedLineSet:

Public Types
enum	Binding { OVERALL , PER_SEGMENT , PER_SEGMENT_INDEXED , PER_LINE , PER_LINE_INDEXED , PER_VERTEX , PER_VERTEX_INDEXED }
	This enum is used to indicate the current material or normal binding. More...

typedef void(SoIndexedLineSet::*	PMILS) (SoGLRenderAction *)
	Typedef of pointer to method on IndexedLineSet; This will be used to simplify declaration and initialization. More...

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

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

Public Member Functions
	SoIndexedLineSet ()
	Creates an indexed line set node with default settings. More...

virtual void	GLRender (SoGLRenderAction *action)
	Implements actions. More...

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
	Redefine this to tell open caches that they contain lines. More...

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

Public Member Functions inherited from SoShape
virtual bool	affectsState () const
	Overrides default method on SoNode. 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...

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

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

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

Public Attributes
SoSFBool	sendAdjacency
	flag that defines if the GL_LINES_ADJACENCY/GL_LINE_STRIP_ADJACENCY draw mode is used (MeVis Only) More...

Public Attributes inherited from SoIndexedShape
SoMFInt32	coordIndex
	The indices of the coordinates that the shape uses as its vertices. More...

SoMFInt32	materialIndex
	Material indices. More...

SoMFInt32	normalIndex
	Surface normal indices. More...

SoMFInt32	textureCoordIndex
	Texture Coordinate indices. More...

Public Attributes inherited from SoVertexShape
SoSFNode	vertexProperty

Protected Member Functions
virtual void	generatePrimitives (SoAction *action)
	Generates line segments representing line set. More...

virtual SoDetail *	createLineSegmentDetail (SoRayPickAction action, const SoPrimitiveVertex v1, const SoPrimitiveVertex v2, SoPickedPoint pp)
	Overrides standard method to create an SoLineDetail instance. More...

virtual	~SoIndexedLineSet ()

Protected Member Functions inherited from SoIndexedShape
	SoIndexedShape ()
	Constructor - makes this abstract. More...

virtual void	computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
	This handles bounding box computation for all shapes derived from this class. More...

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

void	setupIndices (int numParts, int numFaces, bool needNormals, bool needTexCoords)
	Setup for fast rendering. More...

const int32_t *	getNormalIndices ()
	These must not be called unless setupIndices has been called first: More...

const int32_t *	getColorIndices ()

const int32_t *	getTexCoordIndices ()

virtual	~SoIndexedShape ()

Protected Member Functions inherited from SoVertexShape
	SoVertexShape ()
	Constructor - makes this abstract. More...

virtual	~SoVertexShape ()

SoVertexProperty *	getVertexProperty ()
	Get the SoVertexProperty from the vertexProperty field, returning NULL if the contained node is not of type SoVertexProperty. More...

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

void	setNormalCache (SoState state, int numNormals, const SbVec3f normals)
	Sets up a cache to hold normals. More...

SoNormalCache *	getNormalCache () const
	Returns the current normal cache, or NULL if there is none. More...

bool	beginVertexArrayRendering (SoGLRenderAction *action)
	enables vertex array rendering client state and VBO rendering (if supported), returns true if VBOs are used (MeVis ONLY) More...

void	endVertexArrayRendering (SoGLRenderAction *action, bool vboWasUsed)
	disables vertex array rendering and VBOs if vboWasUsed is passes as true (MeVis ONLY) More...

Protected Member Functions inherited from SoShape
	SoShape ()
	Constructor. 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 *	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...

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 SoIndexedShape
static bool	areTexCoordsIndexed (SoAction *action)
	Returns TRUE if texture coordinates should be indexed. 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 SoVertexShape
SoVertexPropertyCache	vpCache
	vpCache stores information from one render to the next about what information needs to be grabbed from the state, etc. 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...

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

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

Detailed Description

This node represents a 3D shape formed by constructing polylines from vertices located at the coordinates specified in the vertexProperty field (from SoVertexShape), or the current inherited coordinates. For optimal performance, the vertexProperty field is recommended.

SoIndexedLineSet uses the indices in the coordIndex field (from SoIndexedShape) to specify the polylines. An index of SO_END_LINE_INDEX (-1) indicates that the current polyline has ended and the next one begins.

The coordinates of the line set are transformed by the current cumulative transformation. The lines are drawn with the current light model and drawing style (drawing style FILLED is treated as LINES).

Treatment of the current material and normal binding is as follows: The PER_PART binding specifies a material or normal for each segment of the line. The PER_FACE binding specifies a material or normal for each polyline. PER_VERTEX specifies a material or normal for each vertex. The corresponding _INDEXED bindings are the same, but use the materialIndex or normalIndex indices (see SoIndexedShape). The default material binding is OVERALL. The default normal binding is PER_VERTEX_INDEXED

The current complexity value has no effect on the rendering of indexed line sets.

File Format/Default

: IndexedLineSet {

coordIndex 0

materialIndex -1

normalIndex -1

textureCoordIndex -1

}

SoIndexedShape::normalIndex
SoMFInt32 normalIndex
Surface normal indices.
Definition: SoIndexedShape.h:145

SoIndexedShape::coordIndex
SoMFInt32 coordIndex
The indices of the coordinates that the shape uses as its vertices.
Definition: SoIndexedShape.h:141

SoIndexedShape::textureCoordIndex
SoMFInt32 textureCoordIndex
Texture Coordinate indices.
Definition: SoIndexedShape.h:147

SoIndexedShape::materialIndex
SoMFInt32 materialIndex
Material indices.
Definition: SoIndexedShape.h:143

Action Behavior

: SoGLRenderAction
Draws lines based on the current coordinates, normals, materials, drawing style, and so on.

: SoRayPickAction
Picks lines based on the current coordinates and transformation. Details about the intersection are returned in an SoLineDetail.

: SoGetBoundingBoxAction
Computes the bounding box that encloses all vertices of the line set with the current transformation applied to them. Sets the center to the average of the coordinates of all vertices.

: SoCallbackAction
If any line segment callbacks are registered with the action, they will be invoked for each successive segment in the line set.

See Also

: SoCoordinate3, SoDrawStyle, SoLineDetail, SoLineSet, SoVertexProperty

Definition at line 137 of file SoIndexedLineSet.h.

Member Typedef Documentation

◆ PMILS

typedef void(SoIndexedLineSet::* SoIndexedLineSet::PMILS) (SoGLRenderAction *)

Definition at line 160 of file SoIndexedLineSet.h.

Member Enumeration Documentation

◆ Binding

enum SoIndexedLineSet::Binding

Enumerator
OVERALL
PER_SEGMENT
PER_SEGMENT_INDEXED
PER_LINE
PER_LINE_INDEXED
PER_VERTEX
PER_VERTEX_INDEXED

Definition at line 166 of file SoIndexedLineSet.h.

Constructor & Destructor Documentation

◆ SoIndexedLineSet()

SoIndexedLineSet::SoIndexedLineSet ( )

◆ ~SoIndexedLineSet()

virtual SoIndexedLineSet::~SoIndexedLineSet ( )

protectedvirtual

Member Function Documentation

◆ createLineSegmentDetail()

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

protectedvirtual

Reimplemented from SoShape.

◆ generatePrimitives()

virtual void SoIndexedLineSet::generatePrimitives ( SoAction * action )

protectedvirtual

Implements SoShape.

◆ getBoundingBox()

virtual void SoIndexedLineSet::getBoundingBox ( SoGetBoundingBoxAction * action )

virtual

Reimplemented from SoShape.

◆ GLRender()

virtual void SoIndexedLineSet::GLRender ( SoGLRenderAction * action )

virtual

Reimplemented from SoShape.

◆ initClass()

static void SoIndexedLineSet::initClass ( )

static

Member Data Documentation

◆ sendAdjacency

SoSFBool SoIndexedLineSet::sendAdjacency

Definition at line 145 of file SoIndexedLineSet.h.

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

/home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoIndexedLineSet.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PMILS

Member Enumeration Documentation

◆ Binding

Constructor & Destructor Documentation

◆ SoIndexedLineSet()

◆ ~SoIndexedLineSet()

Member Function Documentation

◆ createLineSegmentDetail()

◆ generatePrimitives()

◆ getBoundingBox()

◆ GLRender()

◆ initClass()

Member Data Documentation

◆ sendAdjacency