SoEdgeFlag Class Reference

Class to mark/unmark edges for beveling. More...

#include <Inventor/nodes/SoEdgeFlag.h>

Inheritance diagram for SoEdgeFlag:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoEdgeFlag ()
	Constructor.
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 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
SoMFInt32	edgeMarked
SoMFInt32	edgeUnmarked
	These are the fields for marked/unmarked edges.

Detailed Description

Class to mark/unmark edges for beveling.

This node defines the current marked/unmarked edges for all subsequent shapes.

The marking/unmarking of the edges is specified using an int_32t array. The meaning of this array and its elements depends on the shape it is applied to.

SoIndexedFaceSet

• For an SoIndexedFaceSet, each element of the array is an index in the SoIndexedShape::coordIndex field. The vertex corresponding to this index is the first vertex of the edge. The other vertex of the edge is the next vertex in the face according to the order of the vertices in the SoIndexedFaceSet array. If the next element in the array is -1 (end of face), the next vertex is the first vertex of the current face (as for edge (5,3) in the example below). Otherwise, the next vertex is the next element in the array (as for edge (1,2) in the example below). The same edge can appear in two different faces, but it is not necessary to mark it in both faces; only one mark per edge is needed.

  Example:

  	0 1 2 3 4 5 6 7 8 9 10 11
  coordIndex =	[ 0, 1 , 2 , -1, 3 , 4, 5 , -1, 2, 1, 3, -1 ]
  edgeMarks =	[ 1 => edge (1, 2),
  	6 => edge (5, 3) ]

SoFaceSet

• For an SoFaceSet, the marking is a little different from the SoIndexedFaceSet. Each element is an index directly in the coordinate array. This corresponds to the first vertex of the edge; the other is the next vertex in the same face. As each face description in the coordinate array is cyclic, the other vertex is either the next vertex in the array, or the first vertex of the face if it is the end of the face.

  Example:

  coordinates =	[{0.0, 1.0, 1.0},	// 0 ... start face 1
  	{0.0, 0.0, 1.0} ,	// 1
  	{1.0, 0.0, 1.0} ,	// 2
  	{0.0, 1.0, 1.0} ,	// 3 ... start face 2
  	{0.0, 0.0, 1.0},	// 4
  	{1.0, 0.0, 0.0} ]	// 5
  numVertices =	[ 3, 3 ]
  edgeMarks =	[ 1=> edge ({0.0, 0.0, 1.0}, {1.0, 0.0, 1.0}),
  	5 => edge ({1.0, 0.0, 0.0}, {0.0, 1.0, 1.0}) ]

SoTriangleStripSet

• For an SoTriangleStripSet, marking an edge is very different from the previous two nodes. If m is a mark, the edge corresponding is computed as follows:
  . the first vertex is int( m /2),
  . the opposite vertex in the edge is int( m /2) + m %2 + 1; if ( m %2) = 0, this is the next vertex, otherwise this is the vertex just after, in the coordinate array.

  Example:

  coordinates =	[ {0.0, 1.0, 1.0} ,	// 0 = int(1/2)
  	{0.0, 0.0, 1.0},	// 1
  	{1.0, 0.0, 1.0} ,	// 2 = int(1/2) + 1 + (1%2)
  	{1.0, 1.0, 1.0},	// 3
  	{0.0, 1.0, 1.0} ,	// 4 = int(8/2)
  	{1.0, 0.0, 0.0} ]	// 5 = int(8/2) + 1 + (8%2)
  edgeMarks =	[ 1=>edge({0.0, 1.0, 1.0}, {1.0, 0.0, 1.0}),
  	8 =>edge({0.0, 1.0, 1.0}, {1.0, 0.0, 0.0}) ]

SoIndexedTriangleStripSet

• An SoIndexedTriangleStripSet works like an SoTriangleStripSet, except that the SoIndexedShape::coordIndex array is used instead of the coordinate array.

SoQuadMesh

• For an SoQuadMesh, the principle is the same as for SoTriangleStripSet. If m is the mark, then the corresponding edge is ( m /2, n ) where n is:
  . the vertex just at the right of the vertex m /2 if ( m %2) = 0,
  . the vertex just below if ( m %2) = 1.

  Example:

  coordinates =	[ {0.0, 1.0, 1.0} , {0.0, 2.0, 2.0}, {0.0, 3.0, 3.0},
  	{1.0, 0.0, 1.0} , {2.0, 0.0, 2.0}, {3.0, 0.0, 3.0},
  	{0.0, 1.0, 0.0}, {0.0, 2.0, 0.0} , {0.0, 3.0, 0.0} ]
  edgeMarks =	[ 1=> edge({0.0, 1.0, 1.0}, {1.0, 0.0, 1.0}),
  	14 => edge({0.0, 2.0, 0.0}, {0.0, 3.0, 0.0}) ]

SoCube

• For an SoCube, edges are identified as shown below:

  

  For each value between [0,11] in the flag array, the corresponding edge is marked/unmarked.

SoCone

• For an SoCone, only the edges of the base can be marked/unmarked. The flag array must contain at least one value greater than or equal to 0 to mark/unmark the edges of the base.

SoCylinder

• For an SoCylinder, only two values in the flag array are significant:

  • array index 0: mark/unmark the edges around the bottom of the cylinder,
  • array index 1: mark/unmark the edges around the top of the cylinder.

FILE FORMAT/DEFAULT

EdgeFlag {

edgeMarked	-1
edgeUnmarked	-1

}

ACTION BEHAVIOR

Sets: SoEdgeFlagElement

SEE ALSO

SoBevelAction, SoBevelProperty, SoVertexFlag

Definition at line 201 of file SoEdgeFlag.h.

Constructor & Destructor Documentation

SoEdgeFlag()

SoEdgeFlag::SoEdgeFlag

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoEdgeFlag::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoEdgeFlag::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

edgeMarked

SoMFInt32 SoEdgeFlag::edgeMarked

Definition at line 208 of file SoEdgeFlag.h.

edgeUnmarked

SoMFInt32 SoEdgeFlag::edgeUnmarked

These are the fields for marked/unmarked edges.

Definition at line 214 of file SoEdgeFlag.h.

---

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

• Inventor/nodes/SoEdgeFlag.h