H3D API  2.4.1
Public Member Functions | Protected Member Functions | List of all members
H3D::X3DTimeDependentNode::StartTime Class Reference

The StartTime field is a specialization of the SFTime field so that the value cannot be changed when the isActive field of the X3DTimeDependentNode it resides in is true. More...

#include <H3D/X3DTimeDependentNode.h>

Inheritance diagram for H3D::X3DTimeDependentNode::StartTime:
Inheritance graph

Public Member Functions

virtual void setValue (const H3DDouble &time, int _id=0)
 Overrides the setValue function so that the value is only changed if the owner X3DTimeDependentNode is inactive. More...
 
- Public Member Functions inherited from H3D::SFTime
virtual string getTypeName ()
 Returns a string name for this field type e.g. SFInt32.
 
- Public Member Functions inherited from H3D::SField< H3DDouble >
 SField ()
 Constructor.
 
 SField (const H3DDouble &_value)
 Constructor.
 
virtual int setValueFromVoidPtr (const void *data, unsigned int len, int id=0)
 Set the value of the field given a pointer to where the value of the field is. More...
 
virtual int getValueAsVoidPtr (void *data, unsigned int len, int id=0)
 Get the value of the data copied into a memory buffer. More...
 
virtual unsigned int valueTypeSize ()
 Returns the size in bytes of the value type the sfield encapsulates.
 
virtual void setValue (const H3DDouble &v, int id=0)
 Set the value of the field.
 
virtual const H3DDoublegetValue (int id=0)
 Get the value of the field.
 
virtual void setValueFromString (const string &s)
 Set the value of the field given a string. More...
 
virtual string getValueAsString (const string &=" ")
 Get the value of the field as a string.
 
- Public Member Functions inherited from H3D::SFieldClass
virtual ~SFieldClass ()
 Virtual destructor.
 
virtual int setValueFromVoidPtr (void *data, unsigned int size, int id=0)
 

Protected Member Functions

virtual void propagateEvent (Event e)
 Overrides the propagateEvent function so that the event is only propagated if the owner X3DTimeDependentNode is inactive. More...
 
- Protected Member Functions inherited from H3D::TypedField< SFDouble, void, AnyNumber< SFTime > >
void checkFieldType (Field *f, int index)
 Function for checking that a field is of a correct type given type specification according to the TypedField template arguments. More...
 
void checkTemplateArguments ()
 Function for checking that a field given TypedField type specification is valid. More...
 
- Protected Member Functions inherited from H3D::SField< H3DDouble >
virtual void update ()
 Make the field up to date given that an event has occured.
 
- Protected Member Functions inherited from H3D::TypedField< BaseField, RequiredArgTypes, OptionalArgTypes >
void checkFieldType (Field *f, int index)
 Function for checking that a field is of a correct type given type specification according to the TypedField template arguments. More...
 
void checkTemplateArguments ()
 Function for checking that a field given TypedField type specification is valid. More...
 

Additional Inherited Members

- Public Types inherited from H3D::SField< H3DDouble >
typedef H3DDouble value_type
 The type of the value member.
 
- Static Public Member Functions inherited from H3D::SField< H3DDouble >
static string classTypeName ()
 Returns a string name for this field type e.g. SFInt32.
 
- Protected Attributes inherited from H3D::SField< H3DDouble >
H3DDouble value
 The encapsulated value.
 

Detailed Description

The StartTime field is a specialization of the SFTime field so that the value cannot be changed when the isActive field of the X3DTimeDependentNode it resides in is true.

This is according to the X3D spec.

Member Function Documentation

◆ propagateEvent()

virtual void H3D::X3DTimeDependentNode::StartTime::propagateEvent ( Event  e)
inlineprotectedvirtual

Overrides the propagateEvent function so that the event is only propagated if the owner X3DTimeDependentNode is inactive.


References H3D::X3DTimeDependentNode::isActive.

◆ setValue()

virtual void H3D::X3DTimeDependentNode::StartTime::setValue ( const H3DDouble time,
int  _id = 0 
)
inlinevirtual

Overrides the setValue function so that the value is only changed if the owner X3DTimeDependentNode is inactive.


References H3D::X3DTimeDependentNode::isActive, and H3D::SField< H3DDouble >::setValue().


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