ML Reference
ml::Vector4Field Class Reference

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

#include <mlFields.h>

Inheritance diagram for ml::Vector4Field:
ml::Field ml::PlaneField ml::RotationField

List of all members.

Public Member Functions

 Vector4Field ()
 Default constructor, do not use it.
 Vector4Field (const std::string &name)
 Constructor, creates a field with a name to manage a vector of 4 double values.
void setStringValue (const std::string &stringValue)
 Sets the value of the field to stringValue.
void setVector4Value (const Vector4 &vectorValue)
 Sets the value of the field to vectorValue.
void updateVector4Value (const Vector4 &vectorValue)
 Sets the value of the field to vectorValue, but only touch field if the new value is different from the old value.
void setVectorValue (const Vector4 &vectorValue)
 Sets the value of the field to vectorValue.
std::string getStringValue () const
 Returns the value of the field as a string value.
const Vector4getVector4Value () const
 Returns the value of the field.
const Vector4getVectorValue () const
 Returns the value of the field.
Deprecated
void setVec4fValue (const Vector4 &value)
const Vector4getVec4fValue () const
 Vector4Field (const std::string &name, Vector4 *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 4 double values.

Definition at line 1397 of file mlFields.h.


Constructor & Destructor Documentation

ml::Vector4Field::Vector4Field ( )

Default constructor, do not use it.

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

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

Default value is (0,0,0,0).

ml::Vector4Field::Vector4Field ( const std::string &  name,
Vector4 valuePtr 
)

Member Function Documentation

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

Returns the value of the field as a string value.

setStringValue must be able to reinterpret this returned string correctly.

Implements ml::Field.

const Vector4& ml::Vector4Field::getVec4fValue ( ) const [inline]
Deprecated:
Use getVector4Value instead.

Definition at line 1463 of file mlFields.h.

const Vector4& ml::Vector4Field::getVector4Value ( ) const

Returns the value of the field.

const Vector4& ml::Vector4Field::getVectorValue ( ) const [inline]

Returns the value of the field.

Definition at line 1435 of file mlFields.h.

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

Sets the value of the field to stringValue.

Implements ml::Field.

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

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::Vector4Field::setVec4fValue ( const Vector4 value) [inline]
Deprecated:
Use setVector4Value instead.

Definition at line 1460 of file mlFields.h.

void ml::Vector4Field::setVector4Value ( const Vector4 vectorValue)

Sets the value of the field to vectorValue.

void ml::Vector4Field::setVectorValue ( const Vector4 vectorValue) [inline]

Sets the value of the field to vectorValue.

Definition at line 1423 of file mlFields.h.

void ml::Vector4Field::updateVector4Value ( const Vector4 vectorValue)

Sets the value of the field to vectorValue, but only touch field if the new value is different from the old value.

(NOTE that values must be identical to avoid touching the field!)


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