Field to encapsulate a vector of 3 double values. More...

#include <mlFields.h>

Inheritance diagram for ml::Vector3Field:

Public Member Functions
	Vector3Field ()
	Default constructor, do not use it.
	Vector3Field (const std::string &name)
	Constructor, creates a field with a `name` to manage a vector of 3 double values.
void	setStringValue (const std::string &stringValue)
	Sets the value of the field to `stringValue`.
void	setVector3Value (const Vector3 &vectorValue)
	Sets the value of the field to `vectorValue`.
void	setVectorValue (const Vector3 &vectorValue)
	Sets the value of the field to `vectorValue`.
std::string	getStringValue () const
	Returns the value of the field as string value setStringValue must be able to reinterpret this returned string correctly.
const Vector3 &	getVector3Value () const
	Returns the value of the field.
const Vector3 &	getVectorValue () const
	Returns the value of the field.
Deprecated
void	setVec3fValue (const Vector3 &value)
const Vector3 &	getVec3fValue () const
	Vector3Field (const std::string &name, Vector3 *valuePtr)
Protected Member Functions
virtual void	setValueFromField (const Field &field)
	Reimplementation from Field which copies the field value more efficiently.

Detailed Description

Field to encapsulate a vector of 3 double values.

Definition at line 1261 of file mlFields.h.

Constructor & Destructor Documentation

ml::Vector3Field::Vector3Field ( )

Default constructor, do not use it.

ml::Vector3Field::Vector3Field ( const std::string & name )

Constructor, creates a field with a name to manage a vector of 3 double values.

Default value is (0,0,0).

std::string ml::Vector3Field::getStringValue ( ) const [virtual]

Returns the value of the field as string value setStringValue must be able to reinterpret this returned string correctly.

Implements ml::Field.

const Vector3& ml::Vector3Field::getVec3fValue ( ) const [inline]

Definition at line 1322 of file mlFields.h.

const Vector3& ml::Vector3Field::getVector3Value ( ) const

Returns the value of the field.

const Vector3& ml::Vector3Field::getVectorValue ( ) const [inline]

Returns the value of the field.

Definition at line 1293 of file mlFields.h.

void ml::Vector3Field::setStringValue ( const std::string & stringValue ) [virtual]

Sets the value of the field to stringValue.

Implements ml::Field.

virtual void ml::Vector3Field::setValueFromField ( const Field & field ) [protected, virtual]

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::Vector3Field::setVec3fValue ( const Vector3 & value ) [inline]

Definition at line 1319 of file mlFields.h.

void ml::Vector3Field::setVector3Value ( const Vector3 & vectorValue )

Sets the value of the field to vectorValue.

void ml::Vector3Field::setVectorValue ( const Vector3 & vectorValue ) [inline]

Sets the value of the field to vectorValue.

Definition at line 1282 of file mlFields.h.

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