Class to build a time axis. More...

#include <MeshViz/graph/PoTimeAxis.h>

Inheritance diagram for PoTimeAxis:

Public Types
enum	Language { ENGLISH , FRANCAIS , DEUTSCH , ESPANOL }
	Language used for date. More...

enum	GradFit { GRAD_FIT , GRAD_UNFIT }

enum	Type { X , Y }
	Axis orientation. 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.

	PoTimeAxis ()
	Constructor.

	PoTimeAxis (const char _startDate, const char _endDate, float _coord, Type _type=X)
	Constructor.

virtual void	rebuild ()
	Forces node-kit rebuilding.

void	setDateFormatMapping (PbDateFormatMapping *formatMapping)
	Sets a reference to a PbDateFormatMapping object for the input date format and for the association dates, coordinates.

const PbDateFormatMapping *	getDateFormatMapping () const
	Gets a reference to a PbDateFormatMapping object for the input date format and for the association dates, coordinates.

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.

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
SoSFString	startDate
	Start date of the axis.

SoSFString	endDate
	End date of the axis.

SoSFFloat	coord
	Abscissa or ordinate of the axis according to the axis type.

SoSFEnum	type
	Axis type.

SoSFEnum	language
	Language of date graduations.

SoSFEnum	gradFit
	This flag indicates if the first graduation is in round figures or not.

SoMFString	gradRep
	List of date representation.

SoSFString	timesPeriod
	String containing gradRep.getNum() -1 sub-strings.

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.

Friends
int	tpdlparse (void)

int	tpdllex (void)

int	tpaxparse (void)

int	tpaxlex (void)

Detailed Description

Class to build a time axis.

This class builds a time axis in the plane XY. A time axis is an axis with date graduations.

The abscissa or ordinate (following "type" field) of the start point of the axis is startDate. The abscissa or ordinate (following "type" field) of the end point of the axis is endDate. Both these abscissas and ordinates are computed according to the association between a dates range and a coordinates range defined by the the current date mapping.

Both startDate and endDate are described by character strings. The syntax must fit the current date format, otherwise the axis is not built.

The current date format and the current date mapping are defined as follows : If the method setDateFormatMapping(formatMapping) is called, the current date format and the current date mapping are defined by "formatMapping". Otherwise the current date format and the current date mapping are specified in the current inherited state (cf property node PoDateFormatMapping).

Axis graduations are displayed depending on date representation given by the fields gradRep and timesPeriod. gradRep is a list of representations and timesPeriod is a list of possible duration.

Let D be the duration between startDate and endDate (date at the start and the end of the axis), and let Di (0 <= i < gradRep.getNum()) be the set of duration defined by the parameter timesPeriod. The choice of a representation is done as follows:

    if  D < D0                   the axis is built using representation gradRep[0]
    if  Di <= D < Di+1           the axis is built using representation gradRep[i+1]
    if  DgradRep.getNum()-2 < D  the axis is built using representation
                                 gradRep[gradRep.getNum() -1]

If the duration list is not provided (empty string), the representation is not chosen depending on D. It is chosen depending on calendar threads given with each representation.

Syntax of the string timesPeriod which defines the set of duration. This is a rational language defined as follows:

    timesPeriod = ([r]U)*
    where (U) is the time units selected from SEC, MIN, HOU, DAY, YEA
    where ([r]) optional positive real value defining the number of units (=1 id r is
    not defined)
    ([r]U)* means that [r]U sequence may be repeated 0 or several times
    The 'space' characters are ignored
    examples:
    timesPeriod = "10SEC  20MIN  HOU"
      defines 3 duration: 10 seconds, 20 minutes et 1 hour
    timesPeriod = "0.2SEC  30MIN  10DAY  2YEA"
      defines 4 duration: 0.2 seconds, 30 minutes, 10 day et 2 years

remark: For all units but SEC, only the integer part of (r) is used. Specifying a decimal part is then useless.

A date graduation representation allows the application:

to draw it using different levels,
to define a date thread between each graduation of a level,
to display for each graduation of a level, one or several components of the date,
to display any character strings for each graduation.

A graduation representation is defined by:

the number of graduation level,
for each level
- the graduation thread (number of seconds, minutes, hours, days, months or years)
- an optional character string before the first indicator
- a set of appearance indicators of one of the date components, followed by an optional character string.

All levels of graduation are displayed underneath each other for horizontal axes and side by side for vertical axes. The first level is the closest to the main line of the axis, the last one is the furthest. Date components are seconds, minutes, hours, days, months and years.

Syntax of the string gradRep[i] which defines the date representation number i. This is a rational language defined as follows:

    gradRep[i] = R(/R)*
    where (/) stands for the current new line character (attribute of the current
    miscellaneous attributes - cf PoAxis description) (it appears before definition of new level)
    where (R) is the representation of dates for one level. This rational language is
    also defined by:
    R = [[r]U]  ['string']  ([n]C['string'])*
    where [[r]U] (optional) defines the thread between 2 following calendar
    graduations of a level
    where ['string'] (optional) is any character strings between quotes
    where [n]C defines the appearance of one of the date calendar components
     [n]C = (s) to display the number of seconds (0 to 59.999...)
         = (m) to display the number of minutes (0 to 59)
         = (H) to display the number of hours (0 to 23)
         = (D) to display the day number in the month (1 to 31)
         = (nD) to display n first characters of the name of the day of the week
         = (M) to display number of the month (1 to 12)
         = (nM) to display n first characters of the name of the month of the year
         = (Y) or (2Y)to display 2 last digits of the year
         = (4Y)to display all digits of the year

Characters for the day of the month or month of the year are displayed using current language defined by the field language. n is an integer value greater than 0.

Warning: To insert the quote (') character in the string ['string'], it must be repeated twice. If the string must only contain (') character then the string must be defined as ''''. To insert a (") in the string a back-slash character () must be added before it.

Example 1:

    gradRep[i] = "20 SEC 'at'm''''s'sec'  /  1MIN  D 3M Y' ' H'h' m''''  "

defines two levels of graduations:

at the first level:
- graduations are displayed every 20 seconds.
- each of the graduations begins with the character string (at) followed by the number of minutes, the date relating to the graduation, then a (') character, then the number of seconds, and finally the character string (sec). For instance: at 12'50sec
at the second level:
- graduation are displayed for every minutes.
- each of the graduations begins with the number of the day in the month, then the first three characters for the month of the year, then the 2 last digits of the year, then ( ), then the number of hours, then (h),then the number of minutes and finally ('). For instance: 3MAR94 18h13'

Possible appearance of graduation may be for instance:

    at11'50sec   at12'10sec  at12'30sec  at12'50sec  at13'10sec  at13'30sec
                      3MAR94 18h12'   3MAR94 18h13'

Example 2:

    gradRep[i] = "5 MIN H'h'm'''' /  DAY D'-'3M  /  YEA 4Y"

defines three levels of graduation:

at the first level:
- graduations are displayed every 5 minutes.
- each graduation begins with the number of hours of the date relating to the graduation, then (h), then the number of minutes followed by (').
at the second level:
- graduations are displayed for each day.
- each graduation begins with the number of the day, then (-), then the first three characters of the month.
at the third level:
- graduations are displayed using 4 digits for each year.

Possible appearance of graduation may be for instance:

    11h15'   11h20'   11h25'   11h30'   11h35'   11h40'
                              3-MAR
                                1995

Note 1: With a thread in minutes, each graduation is displayed starting at 0 second. With a thread in hour, each graduation is displayed starting at 0 minute, 0 second. With a thread in day, each graduation is displayed starting at 0 hour, 0 minute, 0 second. With a thread in month, each graduation is displayed starting 1st of the month, 0 hour, 0 minute, 0 second. With a thread in year, each graduation is displayed starting 1st of January, 0 hour, 0 minute, 0 second. When for a specific level, all graduations are out of bounds, then a graduation is displayed at the middle of the axis. The previous sample shows this with level 2 graduation (3-MARS) and level 3 one (1995).
Note 2: If gradRep.getNum=0 or gradRep[0] = "", Graph Master does its best to display date graduation using the best possible number of levels and best possible thread. This choice is only relating to duration between the bounding dates of the axis. The field timesPeriod is not used.
Note 3: If a representation does not specify the thread type for the first level (i.e. the field [[r]U] is not defined), then Graph Master computes the thread relating to D duration between the boundary dates of the axis. A calendar component (type [n]C) is automatically chosen by Graph Master and the components defined in the representation with a lower unit are ignored. For instance, if the representation is "3D'-'D':'H'h'm''''s / 3M 4Y", and if Graph Master chooses an hour thread, the minutes and seconds components of the first level won't be displayed, only "3D'- 'D':'H'h'" will be used. If a representation specifies the thread unit, but not the number of units (only [r] is given), then Graph Master also computes this number of units relating to D, but all calendar components of the representation will be used.
Note 4: If a representation does not specify the thread type for the level 2, 3,... (i.e. the field [[r]U] is not defined), then Graph Master chooses the current thread unit depending on previous thread unit. If at level 1, the thread unit is minutes, then thread units at level 2 will be hours,... Note 3 applies when choosing calendar components. For instance if the representation is "5MIN 3D'-'D':'H'h'm'''' / m'min'H'h '3D'-'D", then Graph Master chooses hours as the thread unit for level 2 and only components "'H'h '3D'-'D" will be used at this level.

FILE FORMAT/DEFAULT

PoTimeAxis

gradVisibility	VISILITY_DEPEND
gradPosition	GRAD_DEPEND
gradPath	PATH_DEPEND
gradFontName	""
gradFontSize	0
gradDistAxis	0
gradAddStringVisibility	FALSE
gradAddString	""
marginType	REL_MARGIN
marginStart	0
marginEnd	0
titleVisibility	VISILITY_DEPEND
titlePosition	TITLE_DEPEND
titlePath	PATH_DEPEND
titleFontName	""
titleFontSize	0
titleDistAxis	0
titleString	""
gridVisibility	VISILITY_DEPEND
gridLengthGradSide	0
gridLengthGradOtherSide	1
arrowVisibility	VISIBILITY_DEPEND
arrowHeight	0.03
arrowLength	0.05
tickVisibility	VISIBILITY_DEPEND
tickPosition	TICK_GRAD_SIDE
tickMainLength	0
tickSubLength	0
tickSubDef	PERIOD_MAIN_TICK
tickNumOrPeriod	1
tickFirstGrad	1
tickLastGrad	1
reverseFlag	AXIS_REVERSE_DEPEND
startDate	"1-01-70"
endDate	"2-01-70"
coord	0
type	X
language	ENGLISH
gradFit	GRAD_UNFIT
gradRep	""
timesPeriod	""

CATALOG PARTS

PoTimeAxis

Separator

alternateRep

AppearanceKit

appearance

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

MatrixTransform

domainTransform

Corresponds to the domain transformation.

MatrixTransform

transform

Corresponds to the axis plane orientation matrix.

Separator

bodySep

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

AppearanceKit

bodyApp

Specifies the appearance of the body of the axis.

Group

body

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

Separator

arrowSep

Contains properties and shapes to draw the arrow.

AppearanceKit

arrowApp

Specifies the appearance of the arrow.

Group

arrow

Contains a SoFaceSet shape to draw the arrow.

Separator

subGradTickSep

Contains properties and shapes to draw sub-graduation tick.

AppearanceKit

subGradTickApp

Specifies the appearance of sub-graduation tick.

Group

subGradTick

Contains a SoLineSet shape to draw sub-graduation tick.

Separator

subGradGridSep

Contains properties and shapes to draw sub-graduation grid.

AppearanceKit

subGradGridApp

Specifies the appearance of sub-graduation grid.

Group

subGradGrid

Contains a SoLineSet shape to draw sub-graduation grid.

Separator

mainGradTickSep

Contains properties and shapes to draw main-graduation tick.

AppearanceKit

mainGradTickApp

Specifies the appearance of main-graduation tick.

Group

mainGradTick

Contains a SoLineSet shape to draw main-graduation tick.

Separator

mainGradGridSep

Contains properties and shapes to draw main-graduation grid.

AppearanceKit

mainGradGridApp

Specifies the appearance of main-graduation grid.

Group

mainGradGrid

Contains a SoLineSet shape to draw main-graduation grid.

Separator

mainGradTextSep

Contains properties and shapes to draw main-graduation text.

AppearanceKit

mainGradTextApp

Specifies the appearance of main-graduation text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.

Group

mainGradText

Contains a list of SoAnnoText3 shapes to draw main-graduation text.

Separator

titleSep

Contains properties and shapes to draw title text.

AppearanceKit

titleApp

Specifies the appearance of title text. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.

Group

title

Contains a SoAnnoText3 shape to draw title.

}

Definition at line 305 of file PoTimeAxis.h.

Member Enumeration Documentation

◆ GradFit

enum PoTimeAxis::GradFit

Enumerator
GRAD_FIT	The first graduation is in round figures.
GRAD_UNFIT	The first graduation is not in round figures.

Definition at line 334 of file PoTimeAxis.h.

◆ Language

enum PoTimeAxis::Language

Language used for date.

Enumerator
ENGLISH	The date graduations are displayed in English.
FRANCAIS	The date graduations are displayed in French.
DEUTSCH	The date graduation are displayed in German.
ESPANOL	The date graduations are displayed in Spanish.

Definition at line 315 of file PoTimeAxis.h.

◆ Type

enum PoTimeAxis::Type

Axis orientation.

Enumerator
X	The time axis is a X-axis.
Y	The time axis is a Y-axis.

Definition at line 350 of file PoTimeAxis.h.

Constructor & Destructor Documentation

◆ PoTimeAxis() [1/2]

PoTimeAxis::PoTimeAxis ( )

inline

Constructor.

Definition at line 413 of file PoTimeAxis.h.

◆ PoTimeAxis() [2/2]

PoTimeAxis::PoTimeAxis	(	const char *	_startDate,
		const char *	_endDate,
		float	_coord,
		Type	_type = `X`
	)

inline

Constructor.

Definition at line 419 of file PoTimeAxis.h.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * PoTimeAxis::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType PoTimeAxis::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getDateFormatMapping()

const PbDateFormatMapping * PoTimeAxis::getDateFormatMapping ( ) const

Gets a reference to a PbDateFormatMapping object for the input date format and for the association dates, coordinates.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * PoTimeAxis::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoAxis.

◆ getTypeId()

virtual SoType PoTimeAxis::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoAxis.

◆ rebuild()

virtual void PoTimeAxis::rebuild ( )

virtual

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

◆ setDateFormatMapping()

void PoTimeAxis::setDateFormatMapping ( PbDateFormatMapping * formatMapping )

Sets a reference to a PbDateFormatMapping object for the input date format and for the association dates, coordinates.

If this method is not called (or called passing NULL as argument), this is the date format and date mapping defined in the current inherited state (defined with the property node PoDateFormatMapping) which are used.

Friends And Related Symbol Documentation

◆ tpaxlex

int tpaxlex ( void )

friend

◆ tpaxparse

int tpaxparse ( void )

friend

◆ tpdllex

int tpdllex ( void )

friend

◆ tpdlparse

int tpdlparse ( void )

friend

Member Data Documentation

◆ coord

SoSFFloat PoTimeAxis::coord

Abscissa or ordinate of the axis according to the axis type.

Definition at line 378 of file PoTimeAxis.h.

◆ endDate

SoSFString PoTimeAxis::endDate

End date of the axis.

Make sure that this date is in the same format as defined by the current date format.

Definition at line 373 of file PoTimeAxis.h.

◆ gradFit

SoSFEnum PoTimeAxis::gradFit

This flag indicates if the first graduation is in round figures or not.

Definition at line 393 of file PoTimeAxis.h.

◆ gradRep

SoMFString PoTimeAxis::gradRep

List of date representation.

If the list is empty, the representation is automatically computed.

Definition at line 399 of file PoTimeAxis.h.

◆ language

SoSFEnum PoTimeAxis::language

Language of date graduations.

Definition at line 388 of file PoTimeAxis.h.

◆ startDate

SoSFString PoTimeAxis::startDate

Start date of the axis.

Make sure that this date is in the same format as defined by the current date format.

Definition at line 367 of file PoTimeAxis.h.

◆ timesPeriod

SoSFString PoTimeAxis::timesPeriod

String containing gradRep.getNum() -1 sub-strings.

Each sub-string specifies a time period used to choose the date representation. If this string is empty, this choice is automatically made.

Definition at line 406 of file PoTimeAxis.h.

◆ type

SoSFEnum PoTimeAxis::type

Axis type.

(X or Y).

Definition at line 383 of file PoTimeAxis.h.

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

MeshViz/graph/PoTimeAxis.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

FILE FORMAT/DEFAULT

CATALOG PARTS

Member Enumeration Documentation

◆ GradFit

◆ Language

◆ Type

Constructor & Destructor Documentation

◆ PoTimeAxis() [1/2]

◆ PoTimeAxis() [2/2]

Member Function Documentation

◆ getClassNodekitCatalog()

◆ getClassTypeId()

◆ getDateFormatMapping()

◆ getNodekitCatalog()

◆ getTypeId()

◆ rebuild()

◆ setDateFormatMapping()

Friends And Related Symbol Documentation

◆ tpaxlex

◆ tpaxparse

◆ tpdllex

◆ tpdlparse

Member Data Documentation

◆ coord

◆ endDate

◆ gradFit

◆ gradRep

◆ language

◆ startDate

◆ timesPeriod

◆ type