PoCurveLine Class Reference

Class to build a 2D line curve. More...

#include <MeshViz/graph/PoCurveLine.h>

Inheritance diagram for PoCurveLine:

Public Types
enum	ThicknessBinding {   PER_PART_THICKNESS ,   PER_VERTEX_THICKNESS }
	Thickness binding. More...
Public Types inherited from PoChart
enum	ColorBinding {   INHERITED ,   PER_VERTEX ,   PER_PART }
	Color binding. 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.
	PoCurveLine ()
	Constructor.
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 PoChart
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
SoSFInt32	thicknessIndex
	Defines the index of the set of values used to specify the thickness.
SoSFEnum	thicknessBinding
	Defines how thickness values are bound to the curve.
SoSFFloat	thicknessFactor
	Defines a multiplicative factor applied to the thickness values.
Public Attributes inherited from PoChart
SoSFEnum	colorBinding
	Specify how the colors are bound to the representation.
SoSFInt32	yValuesIndex
	Defines the index of the set of values used by a charting representation as a y-coordinate of each mesh node.
SoSFInt32	colorValuesIndex
	Defines the index of the set of values for the coloring.
SoSFNode	material
	Defines the list of materials used for the coloring.
Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Class to build a 2D line curve.

Builds a 2D curve line on 1D mesh (PoIrregularMesh1D or PoRegularMesh1D). The abscissas of the curve are given by the geometry of the current mesh 1D, and the ordinates are given by one of the value-set of the current mesh 1D specified by the field yValuesIndex. The thickness of the line is specified by the field thicknessIndex which is an index of a value-set of the current mesh 1D. If thicknessIndex == -1, the thickness of the curve is inherited. This class also takes into account of the current mesh 1D hints (PoMesh1DHints). The interpretation of colorBinding is the following :

• INHERITED: The entire curve is colored with the same inherited color.
• PER_PART : Each part of the curve is colored with the same color. A part is the line(s) between two abscissas defined by the current mesh 1D.
• PER_VERTEX: A color is used at each vertex of the curve.

FILE FORMAT/DEFAULT

PoCurveLine {

colorBinding	INHERITED
yValuesIndex	0
colorValuesIndex	1
material	NULL
thicknessIndex	-1
thicknessBinding	PER_VERTEX_THICKNESS
thicknessFactor	1.0

}

CATALOG PARTS

PoCurveLine {

Separator alternateRep (from PoBase) {

AppearanceKit appearance (from PoBase)

Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR. The part material is set when the kit is rebuilt, if the field colorBinding is different from INHERITED.

MatrixTransform domainTransform (from PoBase)

Corresponds to the domain transformation.

Group curve

Contains a SoLineSet shape if the field thicknessIndex =-1, otherwise a list of SoIndexedLineSet shape to draw the curve.

}

}

Definition at line 74 of file PoCurveLine.h.

Member Enumeration Documentation

ThicknessBinding

enum PoCurveLine::ThicknessBinding

Thickness binding.

Enumerator
PER_PART_THICKNESS	Each part of the curve has the same thickness.
PER_VERTEX_THICKNESS	The thickness between two consecutive vertices. is linearly interpolated according to the thickness value associated to these vertices.

Definition at line 87 of file PoCurveLine.h.

Constructor & Destructor Documentation

PoCurveLine()

PoCurveLine::PoCurveLine

(

)

Constructor.

Member Function Documentation

getClassNodekitCatalog()

static const SoNodekitCatalog * PoCurveLine::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

getClassTypeId()

static SoType PoCurveLine::getClassTypeId ( )

static

Returns the type identifier for this class.

getNodekitCatalog()

virtual const SoNodekitCatalog * PoCurveLine::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoChart.

Reimplemented in PoCurveFilling, PoRibbon, and PoTube.

getTypeId()

virtual SoType PoCurveLine::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoChart.

Reimplemented in PoCurveFilling, PoRibbon, and PoTube.

Member Data Documentation

thicknessBinding

SoSFEnum PoCurveLine::thicknessBinding

Defines how thickness values are bound to the curve.

If thicknessBinding = PER_PART_THICKNESS, each part of the curve has the same thickness otherwise the thickness between two consecutive vertices is linearly interpolated according to the thickness value associated to these vertices. For curve line, PER_VERTEX_THICKNESS is interpreted as PER_PART_THICKNESS.

Definition at line 125 of file PoCurveLine.h.

thicknessFactor

SoSFFloat PoCurveLine::thicknessFactor

Defines a multiplicative factor applied to the thickness values.

Definition at line 130 of file PoCurveLine.h.

thicknessIndex

SoSFInt32 PoCurveLine::thicknessIndex

Defines the index of the set of values used to specify the thickness.

If thicknessIndex = -1, all the curve has the same thickness which is the inherited line width.

Definition at line 115 of file PoCurveLine.h.

---

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

• MeshViz/graph/PoCurveLine.h