SoTimeHints Class Reference
[Nodes]

Time series LDM hints. More...

#include <LDM/nodes/SoTimeHints.h>

Inheritance diagram for SoTimeHints:

List of all members.

Public Types
enum	TimeDirection {   BACKWARD,   FORWARD }
Public Member Functions
virtual SoType	getTypeId () const
	SoTimeHints ()
void	setNextTimeStep (unsigned int numTimeSteps)
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFShort	currentTimeStep
SoSFUShort	stepIncrement
SoSFEnum	timeDirection

---

Detailed Description

Time series LDM hints.

This node contains a set of properties to parameterize time series animations. It also enables LDM to prefetch data to be displayed in the future.

NOTES

SoTimeHints was only supported by ReservoirViz module extension.

FILE FORMAT/DEFAULT

TimeHints {

currentTimeStep	0
stepIncremement	1
timeDirection	FORWARD

}

ACTION BEHAVIOR

SoCallbackAction, SoGLRenderAction, SoPickAction, SoWriteAction, SoGetBoundingBoxAction
Sets a time hints in the current traversal state.

Deprecated:


Deprecated since Open Inventor 9000
No longer supported.

---

Member Enumeration Documentation

enum SoTimeHints::TimeDirection

Time direction mode.

Enumerator:

BACKWARD	Time direction is backward.
FORWARD	Time direction is forward.

---

Constructor & Destructor Documentation

SoTimeHints::SoTimeHints

(

)

Constructor.

---

Member Function Documentation

static SoType SoTimeHints::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoNode.

virtual SoType SoTimeHints::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

void SoTimeHints::setNextTimeStep

(

unsigned int

numTimeSteps

)

[inline]

Convenience method to set the currentTimeStep to the next step according to the stepIncrement, the timeDirection, and the number of time steps.

---

Member Data Documentation

SoSFShort SoTimeHints::currentTimeStep

Current time step to play.

SoSFUShort SoTimeHints::stepIncrement

Increment for the next time step to play.

SoSFEnum SoTimeHints::timeDirection

Direction of time.

Use enum TimeDirection. Default is FORWARD.

---

The documentation for this class was generated from the following file:
• LDM/nodes/SoTimeHints.h