MeVisLab Toolbox Reference
ml::Matrix3Field Class Reference

Field encapsulating a 3x3 matrix. More...

#include <mlFields.h>

Inheritance diagram for ml::Matrix3Field:
ml::Field

Public Member Functions

 Matrix3Field (const std::string &name="")
 Implements the runtime type system interface for this class. More...
 
void setStringValue (const std::string &stringValue) override
 Sets the field value to stringValue="a11 a12 ... a33". More...
 
void setMatrixValue (const Matrix3 &matrixValue)
 Sets the value of the field to matrixValue. More...
 
void setMatrix3Value (const Matrix3 &matrixValue)
 Sets the value of the field to matrixValue; same as setMatrixValue for symmetry to other fields. More...
 
void updateMatrix3Value (const Matrix3 &matrixValue)
 Sets the value of the field to matrixValue, but only touch field if the new value is different from the old value. More...
 
std::string getStringValue () const override
 Returns the value of the field as a string value. More...
 
const Matrix3getMatrixValue () const
 Returns the value of the field. More...
 
const Matrix3getMatrix3Value () const
 Returns the value of the field; same as getMatrixValue for symmetry to other fields. More...
 
void setValue (const Matrix3 &matrixValue)
 Same as setMatrix3Value(). More...
 
void updateValue (const Matrix3 &matrixValue)
 Same as updateMatrix3Value(). More...
 
const Matrix3getValue () const
 Same as getMatrix3Value(). More...
 
Deprecated
void setMat3fValue (const Matrix3 &value)
 
void setMat3Value (const Matrix3 &value)
 
const Matrix3getMat3Value () const
 
- Public Member Functions inherited from ml::Field
 Field (const std::string &name=std::string())
 Constructor: Creates a field with name. More...
 
virtual ~Field ()
 Destructor: Destroy field and remove all connection to fields an sensors. More...
 
FieldContainergetFieldContainer () const
 Get the field container of the field (which may be NULL). More...
 
const std::string & getName () const
 Returns name of field. More...
 
void setName (const std::string &name)
 Sets the name of field. Should be called only once after or while construction. More...
 
std::string getFullName () const
 Returns "fieldContainerType(instanceName).fieldName" (if field container is available, otherwise only field name is returned). More...
 
bool isOutputOnly () const
 Returns if this field is marked as pure output field. More...
 
void setOutputOnly (bool outputOnly=true)
 Mark field as a pure output field that is never read by its module. More...
 
virtual MLint isValidValue ()
 Returns true (=1) if the field's value is valid; otherwise false (=0) is returned. More...
 
void copyCStringValue (char *valueBuffer, MLint bufferSize)
 Copies the value of the field (as character string) into the specified buffer valueBuffer. More...
 
MLint getCStringValueSize ()
 Returns the length of the character string of the string value of the field. More...
 
void attachFieldSensor (FieldSensor *sensor)
 Attaches a field sensor sensor of this class instance in both directions. More...
 
void detachFieldSensor (FieldSensor *sensor)
 Detaches the field sensor sensor of this class instance in both directions. More...
 
void detachFieldSensors ()
 Detaches all field sensors of this class instance in both directions. More...
 
void attachField (OutputConnectorField *targetField)
 This calls attachField(targetField, false). More...
 
void attachField (BaseField *targetField)
 
void attachField (SoNodeField *targetField)
 
void attachField (NotifyField *targetField)
 
void attachField (Field *targetField, bool propagateValueOnConnect)
 Connects this class instance with the target field targetField. More...
 
void detachField (Field *targetField)
 Disconnects connections between target field targetField and this instance. More...
 
void detachSourceFields ()
 Disconnects all source fields of this instance in both directions. More...
 
void detachDestinationFields ()
 Disconnects all target fields of this instance in both directions. More...
 
void detachAllFields ()
 Disconnects all source and target fields of this instance in both directions. More...
 
size_t getNumDestinationFields ()
 Returns the number of destination fields which could receive notifications or value sets. More...
 
FieldgetDestinationField (size_t index)
 Returns destination field at index. Returns NULL if index is out of range. More...
 
size_t getNumSourceFields ()
 Returns the number of source fields which could send notifications or value sets. More...
 
FieldgetSourceField (size_t index)
 Returns the source field at index. Returns NULL if index is out of range. More...
 
virtual void touch (FieldSensor::Strength strength=FieldSensor::CHANGED)
 Notifies all connected fields and field sensors. More...
 
void enableNotifications (bool flag)
 Enables or disables notification of attached fields and field sensors when the field value is set or notified (by notifyAttachments() or set*Value() -methods), depending on the parameter flag. More...
 
bool areNotificationsEnabled ()
 Returns whether the notification mechanism for this field (e.g., when field values are set) is enabled (see enableNotifications(bool) ). More...
 

Protected Member Functions

void setValueFromField (const Field &field) override
 Reimplementation from Field which copies the field value more efficiently. More...
 
- Protected Member Functions inherited from ml::Field
void attachSourceField (Field *field)
 Inserts a field as source field in this instance, i.e., from now on *this might receive values and/or notifications from that field. More...
 
void detachSourceField (Field *field)
 Removes a source field from this instance. If not found then this call does nothing. More...
 
void detachFieldInternal (Field *field)
 Only remove the given field from the destination list. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ml::Field
static void enableNotificationsGlobally (bool flag)
 Enables or disables globally the notification mechanism for all fields and field sensors when field values are set or notified (by notifyAttachments() or set*Value() methods), depending on the parameter flag. More...
 
static bool areNotificationsEnabledGlobally ()
 Returns whether the notification mechanism for all fields (e.g., when field values are set) is enabled (see enableNotificationsGlobally(bool) ) Usually it is false(=0) within all calls of Module::calc* methods to avoid that field changes within these methods recursively start the calculation process of the ML. More...
 
static MLintenableNotificationsCounterState ()
 Provides read/write access to the current counter state (see enableNotificationsGlobally(bool) ). More...
 
- Protected Attributes inherited from ml::Field
std::string _name
 The name of this field. More...
 
std::vector< FieldSensor * > _sensors
 List of field sensors. More...
 
std::vector< Field * > _destinationFields
 List of (target) fields which shall be set to the value of this field or which shall be notified only if this field is changed or notified. More...
 
std::vector< Field * > _sourceFields
 List of (source) fields, which will notify this field or which will copy their value to this field. More...
 
FieldContainer_fieldContainer
 The owning field container. More...
 
Flags _flags
 
- Static Protected Attributes inherited from ml::Field
static MLint _enableNotifications
 Flag which disables the notification process of field (sensors) globally. More...
 

Detailed Description

Field encapsulating a 3x3 matrix.

Definition at line 2217 of file mlFields.h.

Constructor & Destructor Documentation

◆ Matrix3Field()

ml::Matrix3Field::Matrix3Field ( const std::string &  name = "")

Implements the runtime type system interface for this class.

Constructor, creates a field with a name to manage a 3x3 matrix initialized to the unit matrix by default.

Member Function Documentation

◆ getMat3Value()

const Matrix3& ml::Matrix3Field::getMat3Value ( ) const
inline
Deprecated:
Use getMatrix3Value instead.

Definition at line 2287 of file mlFields.h.

◆ getMatrix3Value()

const Matrix3& ml::Matrix3Field::getMatrix3Value ( ) const

Returns the value of the field; same as getMatrixValue for symmetry to other fields.

◆ getMatrixValue()

const Matrix3& ml::Matrix3Field::getMatrixValue ( ) const

Returns the value of the field.

◆ getStringValue()

std::string ml::Matrix3Field::getStringValue ( ) const
overridevirtual

Returns the value of the field as a string value.

setStringValue must be able to reinterpret this returned string correctly.

Implements ml::Field.

◆ getValue()

const Matrix3& ml::Matrix3Field::getValue ( ) const
inline

Same as getMatrix3Value().

Definition at line 2263 of file mlFields.h.

◆ setMat3fValue()

void ml::Matrix3Field::setMat3fValue ( const Matrix3 value)
inline
Deprecated:
Use setMatrix3Value instead.

Definition at line 2281 of file mlFields.h.

◆ setMat3Value()

void ml::Matrix3Field::setMat3Value ( const Matrix3 value)
inline
Deprecated:
Use setMatrix3Value instead.

Definition at line 2284 of file mlFields.h.

◆ setMatrix3Value()

void ml::Matrix3Field::setMatrix3Value ( const Matrix3 matrixValue)

Sets the value of the field to matrixValue; same as setMatrixValue for symmetry to other fields.

◆ setMatrixValue()

void ml::Matrix3Field::setMatrixValue ( const Matrix3 matrixValue)

Sets the value of the field to matrixValue.

◆ setStringValue()

void ml::Matrix3Field::setStringValue ( const std::string &  stringValue)
overridevirtual

Sets the field value to stringValue="a11 a12 ... a33".

If less than 9 valid numbers can be scanned in string then all components are set to 0.

Implements ml::Field.

◆ setValue()

void ml::Matrix3Field::setValue ( const Matrix3 matrixValue)
inline

Same as setMatrix3Value().

Definition at line 2257 of file mlFields.h.

◆ setValueFromField()

void ml::Matrix3Field::setValueFromField ( const Field field)
overrideprotectedvirtual

Reimplementation from Field which copies the field value more efficiently.

Reimplemented from ml::Field.

◆ updateMatrix3Value()

void ml::Matrix3Field::updateMatrix3Value ( const Matrix3 matrixValue)

Sets the value of the field to matrixValue, 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!)

◆ updateValue()

void ml::Matrix3Field::updateValue ( const Matrix3 matrixValue)
inline

Same as updateMatrix3Value().

Definition at line 2260 of file mlFields.h.


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