ML Reference
ml::PlaneField Class Reference

Field to encapsulate a vector of 4 double values representing a plane with all properties of Vector4Field. More...

#include <mlFields.h>

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

List of all members.

Public Member Functions

 PlaneField (const std::string &name="")
 Constructor: Create a field with name name to manage a vector of 4 double values interpreted as plane.
void setPlaneValue (double f0, double f1, double f2, double f3)
 Set field value to (f0, f1, f2, f3).
void setPlaneValue (const Plane &p)
 Set field value to p.
void getPlaneValue (double &f0, double &f1, double &f2, double &f3) const
 Returns the value of the field.
void getPlaneValue (Plane &plane) const
 Returns the value of the field.
Plane getPlaneValue () const
 Returns the value of the field.

Detailed Description

Field to encapsulate a vector of 4 double values representing a plane with all properties of Vector4Field.

Definition at line 2664 of file mlFields.h.


Constructor & Destructor Documentation

ml::PlaneField::PlaneField ( const std::string &  name = "") [inline]

Constructor: Create a field with name name to manage a vector of 4 double values interpreted as plane.

Definition at line 2672 of file mlFields.h.


Member Function Documentation

void ml::PlaneField::getPlaneValue ( double &  f0,
double &  f1,
double &  f2,
double &  f3 
) const

Returns the value of the field.

Plane ml::PlaneField::getPlaneValue ( ) const

Returns the value of the field.

void ml::PlaneField::getPlaneValue ( Plane plane) const

Returns the value of the field.

void ml::PlaneField::setPlaneValue ( double  f0,
double  f1,
double  f2,
double  f3 
)

Set field value to (f0, f1, f2, f3).

void ml::PlaneField::setPlaneValue ( const Plane p)

Set field value to p.


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