PoPolarAxis Class Reference

Abstract class for polar axis. More...

#include <MeshViz/graph/PoPolarAxis.h>

Inheritance diagram for PoPolarAxis:

Public Types
enum	MultFactorPosition {   MULT_FACTOR_START ,   MULT_FACTOR_END ,   MULT_FACTOR_EXTR ,   MULT_FACTOR_GRAD }
	Type of position of the multiplicative factor. More...
Public Types inherited from PoAxis
enum	Visibility {   VISIBILITY_OFF ,   VISIBILITY_ON ,   VISIBILITY_DEPEND }
	Enumerations. More...
enum	TextPath {   PATH_RIGHT ,   PATH_LEFT ,   PATH_UP ,   PATH_DOWN ,   PATH_DEPEND }
	Text path type. More...
enum	GradPosition {   GRAD_ABOVE ,   GRAD_BELOW ,   GRAD_DEPEND }
	Graduation position type. More...
enum	MarginType {   REL_MARGIN ,   FIXED_MARGIN }
	Margin type. More...
enum	TickPosition {   TICK_GRAD_SIDE ,   TICK_GRAD_OTHER_SIDE ,   TICK_ACROSS_AXIS }
	Tick position type. More...
enum	TitlePosition {   TITLE_MIDDLE ,   TITLE_END ,   TITLE_DEPEND }
	Title position type. More...
enum	TickSubDef {   NUM_SUB_TICK ,   PERIOD_MAIN_TICK }
	Sub-tick type. More...
enum	AxisReverse {   AXIS_NO_REVERSE ,   AXIS_REVERSE ,   AXIS_REVERSE_DEPEND }
	Axis reverse type. 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.
void	getMultFactor (MultFactorPosition &position, float &distAxis) const
	Returns the current multiplicative factor attributes (those computed can be different from the associated fields).
Public Member Functions inherited from PoAxis
void	setMiscTextAttr (PbMiscTextAttr *textAttr)
	Sets a reference to PbMiscTextAttr object for miscellaneous text attributes.
const PbMiscTextAttr *	getMiscTextAttr () const
	Gets a reference to PbMiscTextAttr object for miscellaneous text attributes.
void	getGrad (Visibility &visibility, GradPosition &position, TextPath &path, SbString &fontName, float &fontSize, float &distAxis, SbBool &addStringVisibility, SbString &addString) const
	Gets the graduations axis attributes computed by the last axis rebuilding.
void	getMargin (MarginType &type, float &start, float &end) const
	Gets the margin axis attributes computed by the last axis rebuilding.
void	getTitle (Visibility &visibility, TitlePosition &position, TextPath &path, SbString &fontName, float &fontSize, float &distAxis, SbString &string) const
	Gets the title axis attributes computed by the last axis rebuilding.
void	getGrid (Visibility &visibility, float &lengthGradSide, float &lengthGradOtherSide) const
	Gets the grid axis attributes computed by the last axis rebuilding.
void	getArrow (Visibility &visibility, float &height, float &length) const
	Gets the arrow axis attributes computed by the last axis rebuilding.
void	getTick (Visibility &visibility, TickPosition &position, float &mainLength, float &subLength, TickSubDef &def, unsigned short &numOrPeriod, unsigned short &firstGrad, unsigned short &lastGrad) const
	Gets the tick axis attributes computed by the last axis rebuilding.
AxisReverse	getReverseFlag () const
	Gets the reverse flag axis attributes computed by the last axis 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.
virtual void	rebuild ()
	Forces the node kit to be rebuilt immediately.
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 PoAxis
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 PoBaseAxis
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
SoSFFloat	offset
	Offset for the axis.
SoSFFloat	startRadius
	Radius at the start of the axis.
SoSFFloat	endRadius
	Radius at the end of the axis.
SoSFFloat	theta
	Rotation angle of the axis in radians.
SoSFEnum	multFactorPosition
	Position of the multiplicative factor.
SoSFFloat	multFactorDistAxis
	Distance from the mutiplicative factor to the axis.
Public Attributes inherited from PoAxis
SoSFEnum	gradVisibility
	Graduations visibility.
SoSFEnum	gradPosition
	Graduations position.
SoSFEnum	gradPath
	Graduations path.
SoSFString	gradFontName
	Graduations font name.
SoSFFloat	gradFontSize
	Font size of the graduations.
SoSFFloat	gradDistAxis
	Distance from the graduations to the axis.
SoSFBool	gradAddStringVisibility
	Specify the visibility of a string concatenated with the graduations.
SoSFString	gradAddString
	String to be concatenated.
SoSFEnum	marginType
	Relative or absolute margin.
SoSFFloat	marginStart
	Margin at the start of the axis.
SoSFFloat	marginEnd
	Margin at the end of the axis.
SoSFEnum	titleVisibility
	Visibility of the title.
SoSFEnum	titlePosition
	Position of the title.
SoSFEnum	titlePath
	Path of the title.
SoSFString	titleFontName
	Title font name.
SoSFFloat	titleFontSize
	Font size of the title.
SoSFFloat	titleDistAxis
	Distance from the title to the axis.
SoSFString	titleString
	Title string.
SoSFEnum	gridVisibility
	Grid lines visibility.
SoSFFloat	gridLengthGradSide
	Grid lines length side graduation texts.
SoSFFloat	gridLengthGradOtherSide
	Grid lines length other side graduation texts.
SoSFEnum	arrowVisibility
	Arrow visibility.
SoSFFloat	arrowHeight
	Arrow height.
SoSFFloat	arrowLength
	Arrow length.
SoSFEnum	tickVisibility
	Tick marks visibility.
SoSFEnum	tickPosition
	Position of the tick marks.
SoSFFloat	tickMainLength
	Main graduations ticks length.
SoSFFloat	tickSubLength
	Secondary graduations ticks length.
SoSFEnum	tickSubDef
	Secondary graduations tick definition.
SoSFUShort	tickNumOrPeriod
	Number of secondary graduations (tickSubDef = NUM_SUB_TICK), or period of texts of graduations (tickSubDef = PERIOD_MAIN_TICK).
SoSFUShort	tickFirstGrad
	First graduation to display.
SoSFUShort	tickLastGrad
	Last graduation to display (number starting with the ending one).
SoSFEnum	reverseFlag
	Allow to reverse the writing path of all axis texts.
Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Detailed Description

Abstract class for polar axis.

Abstract class for polar axes. This class handles the offset, start radius, end radius and the rotation angle theta of polar axis. The inherited fields gridLengthGradSide and gridLengthGradOtherSide are expressed in radians (grid lines are arcs of circle).

Definition at line 43 of file PoPolarAxis.h.

Member Enumeration Documentation

MultFactorPosition

enum PoPolarAxis::MultFactorPosition

Type of position of the multiplicative factor.

Enumerator
MULT_FACTOR_START	The multiplicative factor is at the start of the axis.
MULT_FACTOR_END	The multiplicative factor is at the end of the axis.
MULT_FACTOR_EXTR	The multiplicative factor is at the start and at the end of the axis.
MULT_FACTOR_GRAD	The multiplicative factor is at the graduations of the axis.

Definition at line 59 of file PoPolarAxis.h.

Member Function Documentation

getClassNodekitCatalog()

static const SoNodekitCatalog * PoPolarAxis::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

getClassTypeId()

static SoType PoPolarAxis::getClassTypeId ( )

static

Returns the type identifier for this class.

getMultFactor()

void PoPolarAxis::getMultFactor	(	MultFactorPosition &	position,
		float &	distAxis
	)		const

Returns the current multiplicative factor attributes (those computed can be different from the associated fields).

getNodekitCatalog()

virtual const SoNodekitCatalog * PoPolarAxis::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoAxis.

Reimplemented in PoPolarLinAxis, and PoPolarLogAxis.

getTypeId()

virtual SoType PoPolarAxis::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoAxis.

Reimplemented in PoPolarLinAxis, and PoPolarLogAxis.

Member Data Documentation

endRadius

SoSFFloat PoPolarAxis::endRadius

Radius at the end of the axis.

Definition at line 93 of file PoPolarAxis.h.

multFactorDistAxis

SoSFFloat PoPolarAxis::multFactorDistAxis

Distance from the mutiplicative factor to the axis.

This value is a percentage of the current domain (cf PoBase description). If this value is <= 0, the distance is automatically calculated.

Definition at line 113 of file PoPolarAxis.h.

multFactorPosition

SoSFEnum PoPolarAxis::multFactorPosition

Position of the multiplicative factor.

Definition at line 105 of file PoPolarAxis.h.

offset

SoSFFloat PoPolarAxis::offset

Offset for the axis.

Definition at line 83 of file PoPolarAxis.h.

startRadius

SoSFFloat PoPolarAxis::startRadius

Radius at the start of the axis.

Definition at line 88 of file PoPolarAxis.h.

theta

SoSFFloat PoPolarAxis::theta

Rotation angle of the axis in radians.

Definition at line 98 of file PoPolarAxis.h.

---

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

• MeshViz/graph/PoPolarAxis.h