PoArrow Class Reference
[Misc]

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

#include <MeshViz/graph/PoArrow.h>

Inheritance diagram for PoArrow:

List of all members.

Public Types
enum	PatternType {   NO_PATTERN,   DIRECT_TRIANGLE,   INDIRECT_TRIANGLE,   RECTANGLE }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoArrow ()
	PoArrow (int numPoints, const SbVec2f *_point, PatternType startType=NO_PATTERN, PatternType endType=NO_PATTERN, float _patternWidth=0.05f, float _patternHeight=0.03f)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoMFVec2f	point
SoSFEnum	startPatternType
SoSFEnum	endPatternType
SoSFFloat	patternWidth
SoSFFloat	patternHeight

---

Detailed Description

Class to build a 2D arrow.

This class builds an arrow in the plane XY. The arrow is defined by a point list. The start pattern and the end pattern can be parameterized.

FILE FORMAT/DEFAULT

PoArrow {

point	0 0
startPatternType	NO_PATTERN
endPatternType	NO_PATTERN
patternWidth	0.05
patternHeight	0.03

}

CATALOG PARTS

PoArrow {
Separator alternateRep (from PoBase) {

AppearanceKit appearance (from PoBase)
Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.

MatrixTransform domainTransform (from PoBase)
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.
}
}
}



---

Member Enumeration Documentation

enum PoArrow::PatternType

Type of pattern at the arrow extremities.

Enumerator:

NO_PATTERN	No pattern at the arrow extremity.
DIRECT_TRIANGLE	Direct triangle at the arrow extremity.
INDIRECT_TRIANGLE	Indirect triangle at the arrow extremity.
RECTANGLE	Rectangle at the arrow extremity.

---

Constructor & Destructor Documentation

PoArrow::PoArrow

(

)

[inline]

Default constructor.

PoArrow::PoArrow	(	int	numPoints,
		const SbVec2f *	_point,
		PatternType	startType = NO_PATTERN,
		PatternType	endType = NO_PATTERN,
		float	_patternWidth = 0.05f,
		float	_patternHeight = 0.03f
	)			[inline]

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoArrow::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoGraphMaster.

static SoType PoArrow::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoGraphMaster.

virtual const SoNodekitCatalog* PoArrow::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

virtual SoType PoArrow::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

virtual void PoArrow::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFEnum PoArrow::endPatternType

Defines the end arrow pattern type.

SoSFFloat PoArrow::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).

SoSFFloat PoArrow::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).

SoMFVec2f PoArrow::point

Point list of the arrow.

SoSFEnum PoArrow::startPatternType

Defines the start arrow pattern type.

---

The documentation for this class was generated from the following file:
• MeshViz/graph/PoArrow.h