H3D::Field Class Reference

The Field class. More...

#include <Field.h>

Inheritance diagram for H3D::Field:

List of all members.

Public Types
typedef vector< Field * >	FieldSet
typedef vector< Field * >	FieldVector
enum	AccessType { INITIALIZE_ONLY, OUTPUT_ONLY, INPUT_ONLY, INPUT_OUTPUT }
	The different access types that a field can have. More...
Public Member Functions
	H3D_API_EXCEPTION (FieldAccessError)
	Exception thrown when performing actions that conflict with the field's access type.
	Field ()
	Constructor.
virtual	~Field ()
	Destructor.
virtual void	checkFieldType (Field *f, int index)
	Check that a given input field is of the correct type.
void	setName (string _name)
	Sets local the name of the field. Will be used in error reporting.
string	getName ()
	Gets the name of the field.
string	getFullName ()
	Get the full name of the field including the name of the owner node if it exists (ownername.fieldname).
virtual string	getTypeName ()
	Returns a string name for this field type.
virtual X3DTypes::X3DType	getX3DType ()
	Returns the X3DType of the field.
virtual void	route (Field *, int id=0)
	Set up a route from this field to the field given as argument.
virtual void	routeNoEvent (Field *, int id=0)
	Set up a route from this field to the field given as argument.
virtual void	unroute (Field *)
	Remove the route from this field to the field given as argument.
virtual Field *	replaceRoute (Field *f, unsigned int i, int id=0)
	Replace the i:th route to f with a route from this field.
virtual Field *	replaceRouteNoEvent (Field *f, unsigned int i, int id=0)
	Replace the i:th route to f with a route from this field.
template<class F>
void	route (auto_ptr< F > &f, int id=0)
	Set up a route from this field to the field residing in the auto_ptr given as argument.
template<class F>
void	routeNoEvent (auto_ptr< F > &f, int id=0)
	Set up a route from this field to the field residing in the auto_ptr given as argument.
template<class F>
void	unroute (auto_ptr< F > &f)
	Remove the route from this field to the field residing in the auto_ptr given as argument.
void	unrouteAll ()
	Remove all the routes from this field.
virtual void	upToDate ()
	Check that the field is up-to-date, if not update() is called to make it up-to-date.
bool	isUpToDate ()
	Returns true if the field is up to date, i.e.
virtual void	touch ()
	Generates an event from this field.
Node *	getOwner ()
	Get the Node that contains this field.
void	setOwner (Node *n)
	Set the Node that contains this field.
void	setAccessType (AccessType _access_type)
	Set the access type of the field.
AccessType	getAccessType ()
	Get the access type of the field.
bool	routesTo (Field *f)
	Returns true of this field is routed to the field given as argument.
bool	hasRouteFrom (Field *f)
	Returns true of the field given as argumet is routed to this field.
const FieldVector &	getRoutesIn ()
	Get the Fields that are routed to this Field.
const FieldSet &	getRoutesOut ()
	Get the Fields this Field is routed to.
const Event &	getLatestEvent ()
	Get the latest event.
Static Public Member Functions
static string	classTypeName ()
	Returns a string name for this field type.
Protected Member Functions
virtual void	startEvent ()
	Start a new event from this field.
virtual void	propagateEvent (Event e)
	Propagates an event to all Fields we are routed to.
virtual void	routeFrom (Field *, int id)
	Set up a route to this field from the field given as argument.
virtual void	unrouteFrom (Field *)
	Remove the route to this field from the field given as argument.
virtual Field *	replaceRouteFrom (Field *f, unsigned int i, int id)
	Replace the i:th route to this field with the field given as argument.
virtual void	update ()
	This function will be called to update the field if it has a pending event when the upToDate() function is called.
void	checkAccessTypeRoute (Field *f, int id)
	Check the access type is correct for performing a route from this field to f.
void	checkAccessTypeRouteFrom (Field *f, int id)
	Check the access type is correct for performing a route from f to this field.
void	checkAccessTypeGet (int id)
	Check the access type is valid for getting the value of a field.
void	checkAccessTypeSet (int id)
	Check the access type is valid for changing the value of a field.
int	ownerId ()
	Gets the id of the owner node, -1 if no owner.
Protected Attributes
string	name
	The name of the field.
bool	event_lock
	If true, stops events from being propagated.
bool	update_lock
	If true, stops the update() function from being called in the upToDate() function.
FieldSet	routes_out
	The Fields that this field is routed to.
FieldVector	routes_in
	The Field that are routed to this field.
Event	event
	The last event that happened.
Node *	owner
	The node that contain this field.
AccessType	access_type
	The type of access to the field.
Classes
struct	Event
	The Event struct encapsulates an event in the field network. More...

---

Detailed Description

The Field class.

---

Member Enumeration Documentation

enum H3D::Field::AccessType

The different access types that a field can have. Enumerator: INITIALIZE_ONLY  The value of the field can only be changed before the Node that is the owner of the field has been initialized. If no owner exists it works as an INPUT_OUTPUT field. OUTPUT_ONLY  The value of the field can only read, not set. Only the Node that is the owner of the field can change its value by providing its id to the setValue() function. Also only the owner can set up routes to the field. If no owner exists it works as an INPUT_OUTPUT field. INPUT_ONLY  The value of the field can only set, not read. Only the Node that is the owner of the field can read its value by providing its id to the getValue() function. Also only the owner can set up routes from the field. If no owner exists it works as an INPUT_OUTPUT field. INPUT_OUTPUT  No restrictions on access to the field values or routes.

---

Member Function Documentation

void Field::checkAccessTypeGet (  int  id  )  [protected]

Check the access type is valid for getting the value of a field. Exceptions: FieldAccessError  if the field has the wrong access type.

void Field::checkAccessTypeRoute (  Field *  f, int  id )  [protected]

Check the access type is correct for performing a route from this field to f. Exceptions: FieldAccessError  if the field has the wrong access type.

void Field::checkAccessTypeRouteFrom (  Field *  f, int  id )  [protected]

Check the access type is correct for performing a route from f to this field. Exceptions: FieldAccessError  if the field has the wrong access type.

void Field::checkAccessTypeSet (  int  id  )  [protected]

Check the access type is valid for changing the value of a field. Exceptions: FieldAccessError  if the field has the wrong access type.

virtual void H3D::Field::checkFieldType (  Field *  f, int  index )  [inline, virtual]

Check that a given input field is of the correct type. Needed for TypedField. Parameters: f  The field to check the type for index  The index of the field in the routes_in member. Reimplemented in H3D::TypedField< H3D::SFMatrix4f, Types< SFVec3f, SFRotation, SFVec3f, SFRotation, SFVec3f > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Vec4f, vector< Vec4f >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Vec4f > > >, H3D::TypedField< H3D::SFMatrix4f, Types< SFVec3f, SFVec3f, SFVec3f > >, H3D::TypedField< SFDouble, void, AnyNumber< SFTime > >, H3D::TypedField< SFVec3f, Types< SFFloat, SFVec3f > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Matrix4f, vector< Matrix4f >, ParsableMField > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Matrix3f, vector< Matrix3f >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Matrix4d > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Rotation, vector< Rotation >, ParsableMField > > >, H3D::TypedField< SFQuaternion, Types< SFVec3f, SFRotation > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< H3DInt32, vector< H3DInt32 >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< RGBA > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Matrix3d > > >, H3D::TypedField< MatrixTransform::SFMatrix4f, Types< SFVec3f, SFVec3f, SFBound, SFBool, SFBool > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Vec3f, vector< Vec3f >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< bool > > >, H3D::TypedField< MFVec3f, Types< SFFloat, MFFloat, MFVec3f > >, H3D::TypedField< MFVec2f, Types< SFFloat, MFFloat, MFVec2f > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Vec3d > > >, H3D::TypedField< AutoUpdate< SFBool >, Types< SFBool, SFBool, SFBool, SFBool, MFString, SFFloat > >, H3D::TypedField< SFRotation, Types< SFInt32, SFBool, SFVec2f, SFRotation > >, H3D::TypedField< SFVec3f, Types< SFMatrix3f, SFVec3f > >, H3D::TypedField< SFVec3f, SFBoxBound, SFMatrix4f >, H3D::TypedField< Field, void, AnyNumber< SFNode > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Vec2f, vector< Vec2f >, ParsableMField > > >, H3D::TypedField< Field, void, AnyNumber< MFieldBase< RefClass *, FieldInternals::MFNodeAutoRefVector< RefClass >, Field > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Vec2d > > >, H3D::TypedField< SFVec3f, Types< SFMatrix4f, SFVec3f > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Type, vector< Type >, ParsableMField > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Matrix4d, vector< Matrix4d >, ParsableMField > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Matrix3d, vector< Matrix3d >, ParsableMField > > >, H3D::TypedField< SFInt32, SFBool >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Vec2d, vector< Vec2d >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Type > > >, H3D::TypedField< SFVec3f, Types< SFVec3f, SFFloat > >, H3D::TypedField< PeriodicUpdate< SFInt32 >, Types< SFInt32, SFString > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< string > > >, H3D::TypedField< SFFloat, Types< SFFloat, MFFloat, MFFloat > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Vec4d > > >, H3D::TypedField< SFVec3f, Types< SFVec3f, SFVec3f, SFFloat > >, H3D::TypedField< SFRotation, Types< SFFloat, MFFloat, MFRotation > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Vec3d, vector< Vec3d >, ParsableMField > > >, H3D::TypedField< SFRotation, Types< SFRotation, SFFloat > >, H3D::TypedField< H3D::SFVec3f, Types< SFTime > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< RGB > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Matrix4f > > >, H3D::TypedField< H3DBoundedObject::SFBound, TypedSFNode< X3DCoordinateNode > >, H3D::TypedField< H3D::SFMatrix4f, Types< SFRotation, SFVec3f > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< RGBA, vector< RGBA >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Matrix3f > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Quaternion, vector< Quaternion >, ParsableMField > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< string, vector< string >, ParsableMField > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< bool, vector< bool >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Quaternion > > >, H3D::TypedField< Field, void, AnyNumber< MFieldBase< Node *, FieldInternals::MFNodeAutoRefVector< Node >, Field > > >, H3D::TypedField< SFString, MFString >, H3D::TypedField< SFVec2f, Types< SFFloat, MFFloat, MFVec2f > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< H3DDouble, vector< H3DDouble >, ParsableMField > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< H3DDouble > > >, H3D::TypedField< SFVec3f, Types< SFFloat, MFFloat, MFVec3f > >, H3D::TypedField< ThreadSafeSField< SFBool >, Types< SFInt32 > >, H3D::TypedField< SFColor, Types< SFFloat, MFFloat, MFColor > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Rotation > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< H3DFloat, vector< H3DFloat >, ParsableMField > > >, H3D::TypedField< SFRotation, Types< SFRotation, SFRotation > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< H3DFloat > > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Vec3f > > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< RGB, vector< RGB >, ParsableMField > > >, H3D::TypedField< SFVec4d, Types< SFVec3f, SFVec3f > >, H3D::TypedField< SFTime, SFBool >, H3D::TypedField< MFDouble, void, AnyNumber< MFTime > >, H3D::TypedField< ParsableField, void, AnyNumber< SField< Vec2f > > >, H3D::TypedField< SFBool, SFTime >, H3D::TypedField< MFVec3f, Types< MFVec2f, MFRotation, MFVec2f, MFVec3f > >, H3D::TypedField< X3DTexture2DNode::SFImage, Types< MFString, MFImageLoader > >, H3D::TypedField< ParsableMField, void, AnyNumber< MFieldBase< Vec4d, vector< Vec4d >, ParsableMField > > >, and H3D::TypedField< ParsableField, void, AnyNumber< SField< H3DInt32 > > >.

static string H3D::Field::classTypeName (   )  [inline, static]

Returns a string name for this field type. Must have a static version in order to give relevant error messages in TypedField. Reimplemented in H3D::MFNode, H3D::MFTime, H3D::RefCountMField< RefClass >, H3D::SFColorRGBA, H3D::SField< Type >, H3D::SFNode, H3D::SFTime, H3D::MFieldBase< string, vector< string >, ParsableMField >, H3D::MFieldBase< H3DInt32, vector< H3DInt32 >, ParsableMField >, H3D::MFieldBase< Vec2f, vector< Vec2f >, ParsableMField >, H3D::MFieldBase< Vec3f, vector< Vec3f >, ParsableMField >, H3D::MFieldBase< Vec4f, vector< Vec4f >, ParsableMField >, H3D::MFieldBase< Rotation, vector< Rotation >, ParsableMField >, H3D::MFieldBase< Vec2d, vector< Vec2d >, ParsableMField >, H3D::MFieldBase< Vec3d, vector< Vec3d >, ParsableMField >, H3D::MFieldBase< Vec4d, vector< Vec4d >, ParsableMField >, H3D::MFieldBase< RefClass *, FieldInternals::MFNodeAutoRefVector< RefClass >, Field >, H3D::MFieldBase< RGB, vector< RGB >, ParsableMField >, H3D::MFieldBase< Node *, FieldInternals::MFNodeAutoRefVector< Node >, Field >, H3D::MFieldBase< H3DFloat, vector< H3DFloat >, ParsableMField >, H3D::MFieldBase< Type, vector< Type >, ParsableMField >, H3D::MFieldBase< H3DDouble, vector< H3DDouble >, ParsableMField >, H3D::MFieldBase< Matrix4f, vector< Matrix4f >, ParsableMField >, H3D::MFieldBase< Matrix4d, vector< Matrix4d >, ParsableMField >, H3D::MFieldBase< Matrix3f, vector< Matrix3f >, ParsableMField >, H3D::MFieldBase< Matrix3d, vector< Matrix3d >, ParsableMField >, H3D::MFieldBase< bool, vector< bool >, ParsableMField >, H3D::MFieldBase< RGBA, vector< RGBA >, ParsableMField >, H3D::MFieldBase< Quaternion, vector< Quaternion >, ParsableMField >, H3D::RefCountMField< Node >, H3D::SField< RGB >, H3D::SField< RGBA >, H3D::SField< Matrix3d >, H3D::SField< Matrix4d >, H3D::SField< H3DFloat >, H3D::SField< string >, H3D::SField< Matrix3f >, H3D::SField< Matrix4f >, H3D::SField< Vec2f >, H3D::SField< Vec3f >, H3D::SField< bool >, H3D::SField< Vec2d >, H3D::SField< Vec4f >, H3D::SField< H3DDouble >, H3D::SField< Vec3d >, H3D::SField< Vec4d >, H3D::SField< Quaternion >, H3D::SField< H3DInt32 >, and H3D::SField< Rotation >.

bool H3D::Field::isUpToDate (   )  [inline]

Returns true if the field is up to date, i.e. it has not pending events.

void Field::propagateEvent (  Event  e  )  [protected, virtual]

Propagates an event to all Fields we are routed to. event.ptr && Reimplemented in H3D::AutoUpdate< SFString >, H3D::AutoUpdate< SFBool >, H3D::AutoUpdate< TypedField< SFTime, SFBool > >, H3D::AutoUpdate< SFRotation >, H3D::AutoUpdate< SFVec3f >, H3D::AutoUpdate< TypedField< SFInt32, SFBool > >, H3D::AutoUpdate< Field >, H3D::AutoUpdate< TypedField< SFBool, SFTime > >, and H3D::AutoUpdate< SFTime >.

Field * Field::replaceRoute (  Field *  f, unsigned int  i, int  id = 0 )  [virtual]

Replace the i:th route to f with a route from this field. An event will be generated to that field.

Field * Field::replaceRouteNoEvent (  Field *  f, unsigned int  i, int  id = 0 )  [virtual]

Replace the i:th route to f with a route from this field. No event will be generated to that field.

template<class F> void H3D::Field::route (  auto_ptr< F > &  f, int  id = 0 )  [inline]

Set up a route from this field to the field residing in the auto_ptr given as argument. An event will be generated to that field.

void Field::route (  Field *  , int  id = 0 )  [virtual]

Set up a route from this field to the field given as argument. An event will be generated to that field.

template<class F> void H3D::Field::routeNoEvent (  auto_ptr< F > &  f, int  id = 0 )  [inline]

Set up a route from this field to the field residing in the auto_ptr given as argument. No event will be generated to that field.

void Field::routeNoEvent (  Field *  , int  id = 0 )  [virtual]

Set up a route from this field to the field given as argument. No event will be generated to that field.

void Field::startEvent (   )  [protected, virtual]

Start a new event from this field. Any pending events from incoming routes will be removed, so that the current value is the value of the field.

---

Member Data Documentation

bool H3D::Field::event_lock [protected]

If true, stops events from being propagated. This is used to prevent event propagation to go around in circles in an infinite loop.

Node* H3D::Field::owner [protected]

The node that contain this field. NULL if it is a stand alone field.

---