#include <mlFields.h>

Inheritance diagram for ml::Matrix3Field:

Public Member Functions
	Matrix3Field (const std::string &name="")
	Implements the runtime type system interface for this class.
void	setStringValue (const std::string &stringValue) override
void	setMatrixValue (const Matrix3 &matrixValue)
	Sets the value of the field to `matrixValue`.
void	setMatrix3Value (const Matrix3 &matrixValue)
void	updateMatrix3Value (const Matrix3 &matrixValue)
std::string	getStringValue () const override
const Matrix3 &	getMatrixValue () const
	Returns the value of the field.
const Matrix3 &	getMatrix3Value () const
void	setValue (const Matrix3 &matrixValue)
	Same as setMatrix3Value().
void	updateValue (const Matrix3 &matrixValue)
	Same as updateMatrix3Value().
const Matrix3 &	getValue () const
	Same as getMatrix3Value().
Public Member Functions inherited from ml::Field
	Field (const std::string &name=std::string())
	Constructor: Creates a field with `name`.
virtual	~Field ()
	Destructor: Destroys a field and removes all connection to fields and sensors.
FieldContainer *	getFieldContainer () const
	Returns the field container of the field (which may be NULL).
const std::string &	getName () const
	Returns the name of field.
void	setName (const std::string &name)
	Sets the `name` of field. Should be called only once after or while construction.
std::string	getFullName () const
bool	isOutputOnly () const
	Returns whether this field is marked as a pure output field.
void	setOutputOnly (bool outputOnly=true)
	Marks this field as a pure output field that is only changed by its module.
virtual MLint	isValidValue ()
void	copyCStringValue (char *valueBuffer, MLint bufferSize)
MLint	getCStringValueSize ()
	Returns the length of the character string of the string value of the field.
void	attachFieldSensor (FieldSensor *sensor)
	Attaches a field sensor `sensor` of this class instance in both directions.
void	detachFieldSensor (FieldSensor *sensor)
	Detaches the field sensor `sensor` of this class instance in both directions.
void	detachFieldSensors ()
	Detaches all field sensors of this class instance in both directions.
void	attachField (OutputConnectorField *targetField)
void	attachField (BaseField *targetField)
void	attachField (SoNodeField *targetField)
void	attachField (NotifyField *targetField)
void	attachField (Field *targetField, bool propagateValueOnConnect)
void	detachField (Field *targetField)
	Disconnects connections between the target field `targetField` and this instance.
void	detachSourceFields ()
	Disconnects all source fields of this instance in both directions.
void	detachDestinationFields ()
	Disconnects all target fields of this instance in both directions.
void	detachAllFields ()
	Disconnects all source and target fields of this instance in both directions.
size_t	getNumDestinationFields ()
	Returns the number of destination fields that could receive notifications or value sets.
Field *	getDestinationField (size_t index)
	Returns the destination field at `index`. Returns NULL if `index` is out of range.
size_t	getNumSourceFields ()
	Returns the number of source fields that could send notifications or value sets.
Field *	getSourceField (size_t index)
	Returns the source field at `index`. Returns NULL if `index` is out of range.
virtual void	touch (FieldSensor::Strength strength=FieldSensor::CHANGED)
void	enableNotifications (bool flag)
bool	areNotificationsEnabled ()

Protected Member Functions
void	setValueFromField (const Field &field) override
	Reimplementation from Field that copies the field value more efficiently.
Protected Member Functions inherited from ml::Field
void	attachSourceField (Field *field)
void	detachSourceField (Field *field)
	Removes a source `field` from this instance. If not found, then this call does nothing.
void	detachFieldInternal (Field *field)
	Only removes the given field from the destination list.

Additional Inherited Members
static void	enableNotificationsGlobally (bool flag)
static bool	areNotificationsEnabledGlobally ()
static MLint &	enableNotificationsCounterState ()
Protected Attributes inherited from ml::Field
std::string	_name
	The name of this field.
std::vector< FieldSensor * >	_sensors
	List of field sensors.
std::vector< Field * >	_destinationFields
std::vector< Field * >	_sourceFields
FieldContainer *	_fieldContainer
	The owning field container.
Flags	_flags
Static Protected Attributes inherited from ml::Field
static MLint	_enableNotifications
	Flag that disables the notification process of field (-sensors) globally.

Detailed Description

Field encapsulating a 3x3 matrix.

Definition at line 1438 of file mlFields.h.

Constructor & Destructor Documentation

◆ Matrix3Field()

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

explicit

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

◆ getMatrix3Value()

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

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

Referenced by getValue().

◆ 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 1484 of file mlFields.h.

References getMatrix3Value().

◆ setMatrix3Value()

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

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

Referenced by setValue().

◆ 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 nine 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 1478 of file mlFields.h.

References setMatrix3Value().

◆ setValueFromField()

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

overrideprotectedvirtual

Reimplementation from Field that copies the field value more efficiently.

Reimplemented from ml::Field.

References ml::Field::Field().

◆ updateMatrix3Value()

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

Sets the value of the field to matrixValue, but only touches the field if the new value is different from the old value. Note that values must be identical to avoid touching the field!

Referenced by updateValue().

◆ updateValue()

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

inline

Same as updateMatrix3Value().

Definition at line 1481 of file mlFields.h.

References updateMatrix3Value().

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Matrix3Field()

Member Function Documentation

◆ getMatrix3Value()

◆ getMatrixValue()

◆ getStringValue()

◆ getValue()

◆ setMatrix3Value()

◆ setMatrixValue()

◆ setStringValue()

◆ setValue()

◆ setValueFromField()

◆ updateMatrix3Value()

◆ updateValue()