---

osg::SField< FieldTypeT, fieldNameSpace > Class Template Reference
[FieldLib, SingleFields]

Base class for all single fields, for example SFMatrix. More...

#include <OSGSField.h>

Inheritance diagram for osg::SField< FieldTypeT, fieldNameSpace >:

[legend]Collaboration diagram for osg::SField< FieldTypeT, fieldNameSpace >:

[legend]List of all members.

Public Types
typedef osgIF< fieldNameSpace==1, FieldDataTraits1< FieldTypeT >, FieldDataTraits2< FieldTypeT > >::_IRet	SF1Trait
typedef osgIF< fieldNameSpace==0, FieldDataTraits< FieldTypeT >, SF1Trait >::_IRet	SFieldTraits
typedef SField< FieldTypeT, fieldNameSpace >	Self
typedef FieldTypeT	StoredType
typedef FieldTypeT &	reference
typedef const FieldTypeT &	const_reference
typedef SFieldTraits::ArgumentType	ArgumentType
Public Methods
Constructors
	SField (void)
	SField (const SField &obj)
	SField (ArgumentType value)
Destructor
virtual	~SField (void)
Get
virtual UInt32	getSize (void) const
	Returns the size of the field, allway 1 for single fields.
reference	getValue (void)
	Return a reference to the stored value.
const_reference	getValue (void) const
	Return a const reference to the stored value.
virtual const FieldType &	getType (void) const
	Returns the type of the field.
virtual bool	isEmpty (void) const
	Return 1 as SingleFields contain one value.
Set
virtual void	setAbstrValue (const Field &obj)
	Copies the values from a given field iff the two fieldtypes match.
void	setValue (ArgumentType value)
	Sets the stored value from a given one.
void	setValue (const Self &obj)
	Sets the stored value from a given field.
String IO
virtual void	pushValueByStr (const Char8 *str)
	Sets the field value from a given string.
virtual string &	getValueByStr (string &str) const
	Dump the field to a given string.
virtual string &	getValueByStr (string &str, StringConversionStateBase &state) const
	Sets the field value from a given string.
MT Sync
void	syncWith (Self &source)
Binary Interface
UInt32	getBinSize (void)
void	copyToBin (BinaryDataHandler &pMem)
void	copyFromBin (BinaryDataHandler &pMem)
Assign
void	operator= (const SField &source)
	Sets the stored value from a given one.
Dump
virtual void	dump (void) const
	Dump property contents to stderr, should be changed to use a log stream instead.
Static Public Methods
Class Get
const FieldType &	getClassType (void)
Protected Types
typedef Field	Inherited
	Parent type.
Static Protected Methods
Field *	create (void)
	Create method used by the factory to create an instance.
Protected Attributes
FieldTypeT	_value
	Value store.
Static Protected Attributes
const FieldType	_fieldType

---

Detailed Description

template<class FieldTypeT, Int32 fieldNameSpace = 0>
class osg::SField< FieldTypeT, fieldNameSpace >

Base class for all single fields, for example SFMatrix.

---

Member Typedef Documentation

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef osgIF<fieldNameSpace == 1, FieldDataTraits1<FieldTypeT>, FieldDataTraits2<FieldTypeT> >::_IRet osg::SField< FieldTypeT, fieldNameSpace >::SF1Trait

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef osgIF<fieldNameSpace == 0, FieldDataTraits <FieldTypeT>, SF1Trait>::_IRet osg::SField< FieldTypeT, fieldNameSpace >::SFieldTraits

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef SField<FieldTypeT, fieldNameSpace> osg::SField< FieldTypeT, fieldNameSpace >::Self

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef FieldTypeT osg::SField< FieldTypeT, fieldNameSpace >::StoredType

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef FieldTypeT& osg::SField< FieldTypeT, fieldNameSpace >::reference

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef const FieldTypeT& osg::SField< FieldTypeT, fieldNameSpace >::const_reference

template<class FieldTypeT, Int32 fieldNameSpace = 0> typedef SFieldTraits::ArgumentType osg::SField< FieldTypeT, fieldNameSpace >::ArgumentType

template<class FieldTypeT, Int32 fieldNameSpace = 0> osg::SField< FieldTypeT, fieldNameSpace >::Inherited [protected]

Parent type.

---

Constructor & Destructor Documentation

template<class FieldTypeT, Int32 fieldNameSpace> osg::SField< FieldTypeT, fieldNameSpace >::SField (  void    )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> osg::SField< FieldTypeT, fieldNameSpace >::SField (  const SField< FieldTypeT, fieldNameSpace > &    obj )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> osg::SField< FieldTypeT, fieldNameSpace >::SField (  ArgumentType    value )  [inline, explicit]

template<class FieldTypeT, Int32 fieldNameSpace> osg::SField< FieldTypeT, fieldNameSpace >::~SField (  void    )  [inline, virtual]

---

Member Function Documentation

template<class FieldTypeT, Int32 fieldNameSpace> const FieldType & osg::SField< FieldTypeT, fieldNameSpace >::getClassType (  void    )  [inline, static]

template<class FieldTypeT, Int32 fieldNameSpace> UInt32 osg::SField< FieldTypeT, fieldNameSpace >::getSize (  void    )  const [inline, virtual]

Returns the size of the field, allway 1 for single fields. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> SField< FieldTypeT, fieldNameSpace >::reference osg::SField< FieldTypeT, fieldNameSpace >::getValue (  void    )  [inline]

Return a reference to the stored value.

template<class FieldTypeT, Int32 fieldNameSpace> SField< FieldTypeT, fieldNameSpace >::const_reference osg::SField< FieldTypeT, fieldNameSpace >::getValue (  void    )  const [inline]

Return a const reference to the stored value.

template<class FieldTypeT, Int32 fieldNameSpace> const FieldType & osg::SField< FieldTypeT, fieldNameSpace >::getType (  void    )  const [inline, virtual]

Returns the type of the field. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> bool osg::SField< FieldTypeT, fieldNameSpace >::isEmpty (  void    )  const [inline, virtual]

Return 1 as SingleFields contain one value. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::setAbstrValue (  const Field &    obj )  [inline, virtual]

Copies the values from a given field iff the two fieldtypes match. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::setValue (  ArgumentType    value )  [inline]

Sets the stored value from a given one.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::setValue (  const Self &    obj )  [inline]

Sets the stored value from a given field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::pushValueByStr (  const Char8 *    str )  [inline, virtual]

Sets the field value from a given string. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> string & osg::SField< FieldTypeT, fieldNameSpace >::getValueByStr (  string &    str )  const [inline, virtual]

Dump the field to a given string. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> string & osg::SField< FieldTypeT, fieldNameSpace >::getValueByStr (  string &    str, StringConversionStateBase &    state )  const [inline, virtual]

Sets the field value from a given string. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::syncWith (  Self &    source )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> UInt32 osg::SField< FieldTypeT, fieldNameSpace >::getBinSize (  void    )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::copyToBin (  BinaryDataHandler &    pMem )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::copyFromBin (  BinaryDataHandler &    pMem )  [inline]

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::operator= (  const SField< FieldTypeT, fieldNameSpace > &    source )  [inline]

Sets the stored value from a given one.

template<class FieldTypeT, Int32 fieldNameSpace> void osg::SField< FieldTypeT, fieldNameSpace >::dump (  void    )  const [inline, virtual]

Dump property contents to stderr, should be changed to use a log stream instead. Implements osg::Field.

template<class FieldTypeT, Int32 fieldNameSpace> Field * osg::SField< FieldTypeT, fieldNameSpace >::create (  void    )  [inline, static, protected]

Create method used by the factory to create an instance.

---

Member Data Documentation

template<class FieldTypeT, Int32 fieldNameSpace = 0> const FieldType osg::SField< FieldTypeT, fieldNameSpace >::_fieldType [static, protected]

template<class FieldTypeT, Int32 fieldNameSpace = 0> FieldTypeT osg::SField< FieldTypeT, fieldNameSpace >::_value [protected]

Value store.

---

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

• OSGSField.h
• OSGSField.inl

---