ml::Vector2Field Class Reference
[Fields]

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

#include <mlFields.h>

Inheritance diagram for ml::Vector2Field:

List of all members.

Public Member Functions
	Vector2Field ()
	Default constructor, do not use it.
	Vector2Field (const std::string &name)
	Constructor, creates a field with a name to manage a vector of 2 double values.
void	setStringValue (const std::string &stringValue)
	Sets the value of the field to stringValue.
void	setVector2Value (const Vector2 &vectorValue)
	Sets the value of the field to vectorValue.
void	setVectorValue (const Vector2 &vectorValue)
	Sets the value of the field to vectorValue.
std::string	getStringValue () const
	Returns the value of the field as a string value.
const Vector2 &	getVector2Value () const
	Returns the value of the field.
const Vector2 &	getVectorValue () const
	Returns the value of the field.
Deprecated
void	setVec2fValue (const Vector2 &value)
const Vector2 &	getVec2fValue () const
Deprecated
	Vector2Field (const std::string &name, Vector2 *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 2 double values.

Definition at line 1165 of file mlFields.h.

---

Constructor & Destructor Documentation

ml::Vector2Field::Vector2Field

(

)

Default constructor, do not use it.

ml::Vector2Field::Vector2Field

(

const std::string &

name

)

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

Default is (0,0).

ml::Vector2Field::Vector2Field	(	const std::string &	name,
		Vector2 *	valuePtr
	)

Deprecated:

Use Vector2Field(const std::string& name) instead.

---

Member Function Documentation

std::string ml::Vector2Field::getStringValue

(

)

const [virtual]

Returns the value of the field as a string value.

Implements ml::Field.

const Vector2& ml::Vector2Field::getVec2fValue

(

)

const [inline]

Deprecated:

Use getVector2Value instead.

Definition at line 1224 of file mlFields.h.

const Vector2& ml::Vector2Field::getVector2Value

(

)

const

Returns the value of the field.

const Vector2& ml::Vector2Field::getVectorValue

(

)

const [inline]

Returns the value of the field.

Definition at line 1195 of file mlFields.h.

void ml::Vector2Field::setStringValue

(

const std::string &

stringValue

)

[virtual]

Sets the value of the field to stringValue.

Implements ml::Field.

virtual void ml::Vector2Field::setValueFromField

(

const Field &

field

)

[protected, virtual]

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

void ml::Vector2Field::setVec2fValue

(

const Vector2 &

value

)

[inline]

Deprecated:

Use setVector2Value instead.

Definition at line 1221 of file mlFields.h.

void ml::Vector2Field::setVector2Value

(

const Vector2 &

vectorValue

)

Sets the value of the field to vectorValue.

void ml::Vector2Field::setVectorValue

(

const Vector2 &

vectorValue

)

[inline]

Sets the value of the field to vectorValue.

Definition at line 1186 of file mlFields.h.

---

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

• MeVis/Foundation/Sources/ML/include/mlFields.h