PoCoordinateSystemAxis Class Reference
[Axis]

Class for a 3D axes system. More...

#include <MeshViz/graph/PoCoordinateSystemAxis.h>

Inheritance diagram for PoCoordinateSystemAxis:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoCoordinateSystemAxis ()
	PoCoordinateSystemAxis (const SbVec3f &_start, const SbVec3f &_end, const char *_xTitle, const char *_yTitle, const char *_zTitle, float _arrowLengthFactor, float _titleTranslationFactor)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFVec3f	start
SoSFVec3f	end
SoSFString	xTitle
SoSFString	yTitle
SoSFString	zTitle
SoSFFloat	arrowLengthFactor
SoSFFloat	titleTranslationFactor

---

Detailed Description

Class for a 3D axes system.

Class to build an axes system. It is composed of three vectors, each having a title string at its extremity. A multiplicative factor translates each title string according to each vector length and another one defines the arrow length of vectors relative to the vector length.

FILE FORMAT/DEFAULT

PoCoordinateSystemAxis {

start	0 0 0
end	1 1 1
xTitle	"X"
yTitle	"Y"
zTitle	"Z"
arrowLengthFactor	0.05
titleTranslationFactor	0

}

CATALOG PARTS

PoCoordinateSystemAxis {
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.
PoArrow xArrow
Corresponds to the arrow of the x-axis.
PoArrow yArrow
Corresponds to the arrow of the y-axis.
PoArrow zArrow
Corresponds to the arrow of the z-axis.

Separator xTitleTextSep {
Contains properties and shapes to draw text of the x-axis.
AppearanceKit xTitleTextApp
Specifies the appearance of text of the x-axis.
Group xTitleText
Contains a SoText2 shape to draw text of the x-axis.
}

Separator yTitleTextSep {
Contains properties and shapes to draw text of the y-axis.
AppearanceKit yTitleTextApp
Specifies the appearance of text of the y-axis.
Group yTitleText
Contains a SoText2 shape to draw text of the y-axis.
}

Separator zTitleTextSep {
Contains properties and shapes to draw text of the z-axis.
AppearanceKit zTitleTextApp
Specifies the appearance of text of the z-axis.
Group zTitleText
Contains a SoText2 shape to draw the text of the z-axis.
}
}
}




---

Constructor & Destructor Documentation

PoCoordinateSystemAxis::PoCoordinateSystemAxis

(

)

[inline]

Default constructor.

PoCoordinateSystemAxis::PoCoordinateSystemAxis	(	const SbVec3f &	_start,
		const SbVec3f &	_end,
		const char *	_xTitle,
		const char *	_yTitle,
		const char *	_zTitle,
		float	_arrowLengthFactor,
		float	_titleTranslationFactor
	)			[inline]

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoCoordinateSystemAxis::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoGraphMaster.

static SoType PoCoordinateSystemAxis::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoGraphMaster.

virtual const SoNodekitCatalog* PoCoordinateSystemAxis::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoGraphMaster.

virtual SoType PoCoordinateSystemAxis::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoGraphMaster.

virtual void PoCoordinateSystemAxis::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFFloat PoCoordinateSystemAxis::arrowLengthFactor

Arrow length scale factor.

This is the ratio between the length of the arrow and the length of one of the vectors. This value is normally less than 1. 0.05 by default.

SoSFVec3f PoCoordinateSystemAxis::end

End of the coordinate system.

(1,1,1) by default.

SoSFVec3f PoCoordinateSystemAxis::start

Start of the coordinate system.

(0,0,0) by default.

SoSFFloat PoCoordinateSystemAxis::titleTranslationFactor

Translation factor of the titles (as function of the length of each vector).

0 by default.

SoSFString PoCoordinateSystemAxis::xTitle

String to be displayed at the end of the X coordinate vector.

"X" by default.

SoSFString PoCoordinateSystemAxis::yTitle

String to be displayed at the end of the Y coordinate vector.

"Y" by default.

SoSFString PoCoordinateSystemAxis::zTitle

String to be displayed at the end of the Z coordinate vector.

"Z" by default.

---

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