Class to build a 3D arrow. More...

#include <MeshViz/graph/PoArrow3.h>

Inheritance diagram for PoArrow3:

Public Types
enum	PatternType { NO_PATTERN , DIRECT_TRIANGLE , INDIRECT_TRIANGLE , RECTANGLE }
	Type of pattern at the arrow extremities. More...

Public Types inherited from PoBase
enum	UpdateMethodType { UPDATE_METHOD_IMMEDIATE , UPDATE_METHOD_ON_ACTION }
	Type of update method. More...

enum	NodeWriteFormat { FOLD_NODE_WRITE_FORMAT , UNFOLD_NODE_WRITE_FORMAT }
	Type of write format. More...

enum	TextType { SO_TEXT3 , SO_ANNO_TEXT3 }
	Type of Text. More...

typedef void	PoRebuildCB(void userData, PoBase base)

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.

	PoArrow3 ()
	Default constructor.

	PoArrow3 (int numPoints, const SbVec3f *_point, PatternType startType=NO_PATTERN, PatternType endType=NO_PATTERN, float _patternWidth=0.05f, float _patternHeight=0.03f)
	Constructor.

virtual void	rebuild ()
	Forces node-kit rebuilding.

Public Member Functions inherited from PoBase
void	setUpdateMethod (UpdateMethodType type)
	Sets scene graph update method.

UpdateMethodType	getUpdateMethod () const
	Gets update method.

void	setDomain (PbDomain *dom)
	Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.

const PbDomain *	getDomain () const
	Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.

void	touchKit ()
	Indicates the node kit is modified.

SbBool	isModified () const
	Return TRUE, if the kit has been modified, else otherwise.

SbBool	isBuilt () const
	Indicates if the node kit has been built at least once.

void	addPreRebuildCallback (PoRebuildCB cb, void data)
	Add a callback function to call when the node kit is rebuilt.

void	addPostRebuildCallback (PoRebuildCB cb, void data)
	Add a callback function to call when the node kit is rebuilt.

void	removePreRebuildCallback (PoRebuildCB cb, void data=NULL)
	Remove a callback function to call when the node kit is rebuilt.

void	removePostRebuildCallback (PoRebuildCB cb, void data)
	Remove a callback function to call when the node kit is rebuilt.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Copy method.

virtual SbBool	affectsState () const
	See SoNode::affectsState() for explanations.

Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.

virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.

template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.

SbString	getPartString (const SoBase *part)
	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.

virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.

virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.

SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SoNONUNICODE SbBool	set (const char partNameString, const char parameterString)
	This function allows field values of parts (nodes) to be set.

SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.

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

Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.

virtual	~SoGetView ()

virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.

virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.

virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

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

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

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

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

static void	setNodeWriteFormat (NodeWriteFormat format)
	Sets the node write format.

static NodeWriteFormat	getNodeWriteFormat ()
	Gets the node write format.

static void	setTextType (TextType type)
	Sets the type of text used.

static TextType	getTextType ()
	Gets the type of text used.

static void	setVRML2Mode (SbBool flag)
	Set the VRML2 mode.

static SbBool	isVRML2Mode ()
	Gets the VRML2 mode (TRUE = VRML2 mode, FALSE Inventor mode)

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

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.

static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.

static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.

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
SoMFVec3f	point
	Point list of the arrow.

SoSFEnum	startPatternType
	Defines the start arrow pattern type.

SoSFEnum	endPatternType
	Defines the end arrow pattern type.

SoSFFloat	patternWidth
	Define the width of the start and end arrow pattern.

SoSFFloat	patternHeight
	Define the height of the start and end arrow pattern.

Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Class to build a 3D arrow.

This node draws a 3D arrow. The arrow is defined by a point list. The start pattern and the end pattern can be parameterized.

This node draws a single 3D arrow consisting of a polyline with optional arrowhead or rectangle at each end. Therefore the minimum number of points is 2. Additional points could be used to make, for example, a curved arrow.

FILE FORMAT/DEFAULT

PoArrow3

point	0 0 0
startPatternType	NO_PATTERN
endPatternType	NO_PATTERN
patternWidth	0.05
patternHeight	0.03

CATALOG PARTS

PoArrow3

Separator

alternateRep

AppearanceKit

appearance

Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.

MatrixTransform

domainTransform

Corresponds to the domain transformation.

Separator

bodySep

Contains properties and shapes to draw the body of the arrow.

AppearanceKit

bodyApp

Specifies the appearance of the body of the arrow.

Group

body

Contains a SoLineSet shape to draw the body of the arrow.

Separator

startSep

Contains properties and shapes to draw the start pattern of the arrow.

AppearanceKit

startApp

Specifies the appearance of the start pattern of the arrow.

Group

start

Contains a SoFaceSet shape to draw the start pattern of the arrow.

Separator

endSep

Contains properties and shapes to draw the end pattern of the arrow.

AppearanceKit

endApp

Specifies the appearance of the end pattern of the arrow.

Group

end

Contains a SoFaceSet shape to draw the end pattern of the arrow.

}

Definition at line 64 of file PoArrow3.h.

Member Enumeration Documentation

◆ PatternType

enum PoArrow3::PatternType

Type of pattern at the arrow extremities.

Enumerator
NO_PATTERN	No pattern at the arrow extremity.
DIRECT_TRIANGLE	Direct triangle (pointing away from the polyline) at the arrow extremity.
INDIRECT_TRIANGLE	Indirect triangle (pointing toward the polyline) at the arrow extremity.
RECTANGLE	Rectangle at the arrow extremity.

Definition at line 87 of file PoArrow3.h.

Constructor & Destructor Documentation

◆ PoArrow3() [1/2]

PoArrow3::PoArrow3 ( )

inline

Default constructor.

Definition at line 144 of file PoArrow3.h.

◆ PoArrow3() [2/2]

PoArrow3::PoArrow3	(	int	numPoints,
		const SbVec3f *	_point,
		PatternType	startType = `NO_PATTERN`,
		PatternType	endType = `NO_PATTERN`,
		float	_patternWidth = `0.05f`,
		float	_patternHeight = `0.03f`
	)

inline

Constructor.

Definition at line 151 of file PoArrow3.h.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoArrow3::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoArrow3::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * PoArrow3::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

◆ getTypeId()

virtual SoType PoArrow3::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

◆ rebuild()

virtual void PoArrow3::rebuild ( )

virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

Member Data Documentation

◆ endPatternType

SoSFEnum PoArrow3::endPatternType

Defines the end arrow pattern type.

Definition at line 121 of file PoArrow3.h.

◆ patternHeight

SoSFFloat PoArrow3::patternHeight

Define the height of the start and end arrow pattern.

It is given in the normalized space [0-1]x[0-1]x([0-1]) defined by the current domain (cf PoBase description).

Definition at line 135 of file PoArrow3.h.

◆ patternWidth

SoSFFloat PoArrow3::patternWidth

Define the width of the start and end arrow pattern.

It is given in the normalized space [0-1]x[0-1]x([0-1]) defined by the current domain (cf PoBase description).

Definition at line 128 of file PoArrow3.h.

◆ point

SoMFVec3f PoArrow3::point

Point list of the arrow.

Definition at line 111 of file PoArrow3.h.

◆ startPatternType

SoSFEnum PoArrow3::startPatternType

Defines the start arrow pattern type.

Definition at line 116 of file PoArrow3.h.

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

MeshViz/graph/PoArrow3.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

CATALOG PARTS

Member Enumeration Documentation

◆ PatternType

Constructor & Destructor Documentation

◆ PoArrow3() [1/2]

◆ PoArrow3() [2/2]

Member Function Documentation

◆ getClassNodekitCatalog()

◆ getClassTypeId()

◆ getNodekitCatalog()

◆ getTypeId()

◆ rebuild()

Member Data Documentation

◆ endPatternType

◆ patternHeight

◆ patternWidth

◆ point

◆ startPatternType