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:
Public Member Functions | |
| PlaneField (const std::string &name="") | |
| Implements the runtime type system interface for this class. | |
| 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. | |
 Public Member Functions inherited from ml::Vector4Field | |
| Vector4Field () | |
| Implements the runtime type system interface for this class. | |
| 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) override |
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 override |
| Returns the value of the field as a string value. | |
| const Vector4 & | getVector4Value () const |
| Returns the value of the field. | |
| const Vector4 & | getVectorValue () const |
| Returns the value of the field. | |
| void | setValue (const Vector4 &vectorValue) |
| Same as setVector4Value(). | |
| void | updateValue (const Vector4 &vectorValue) |
| Same as updateVector4Value(). | |
| const Vector4 & | getValue () const |
| Same as getVector4Value(). | |
| Public Member Functions inherited from ml::Field | |
| Field (const std::string &name=std::string()) | |
Constructor: Creates a field with name. | |
| virtual | ~Field () |
| Destructor: Destroy field and remove all connection to fields an sensors. | |
| FieldContainer * | getFieldContainer () const |
| Get the field container of the field (which may be NULL). | |
| const std::string & | getName () const |
| Returns 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 |
| Returns "fieldContainerType(instanceName).fieldName" (if field container is available, otherwise only field name is returned). | |
| bool | isOutputOnly () const |
| Returns if this field is marked as pure output field. | |
| void | setOutputOnly (bool outputOnly=true) |
| Mark field as a pure output field that is never read by its module. | |
| virtual MLint | isValidValue () |
| Returns true (=1) if the field's value is valid; otherwise false (=0) is returned. | |
| void | copyCStringValue (char *valueBuffer, MLint bufferSize) |
Copies the value of the field (as character string) into the specified buffer valueBuffer. | |
| 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) |
| This calls attachField(targetField, false). | |
| 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. | |
| void | detachField (Field *targetField) |
Disconnects connections between 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 which could receive notifications or value sets. | |
| Field * | getDestinationField (size_t index) |
Returns destination field at index. Returns NULL if index is out of range. | |
| size_t | getNumSourceFields () |
| Returns the number of source fields which 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) |
| Notifies all connected fields and field sensors. | |
| 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. | |
| bool | areNotificationsEnabled () |
| Returns whether the notification mechanism for this field (e.g., when field values are set) is enabled (see enableNotifications(bool) ). | |
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. | |
| 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. | |
| static MLint & | enableNotificationsCounterState () |
| Provides read/write access to the current counter state (see enableNotificationsGlobally(bool) ). | |
| Protected Member Functions inherited from ml::Vector4Field | |
| void | setValueFromField (const Field &field) override |
| Reimplementation from Field which copies the field value more efficiently. | |
| 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. | |
| void | detachSourceField (Field *field) |
Removes a source field from this instance. If not found then this call does nothing. | |
| void | detachFieldInternal (Field *field) |
| Only remove the given field from the destination list. | |
| 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 |
| 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. | |
| std::vector< Field * > | _sourceFields |
| List of (source) fields, which will notify this field or which will copy their value to this field. | |
| FieldContainer * | _fieldContainer |
| The owning field container. | |
| Flags | _flags |
| Static Protected Attributes inherited from ml::Field | |
| static MLint | _enableNotifications |
| Flag which disables the notification process of field (sensors) globally. | |
Detailed Description
Field to encapsulate a vector of 4 double values representing a plane with all properties of Vector4Field.
Definition at line 2174 of file mlFields.h.
Constructor & Destructor Documentation
◆ PlaneField()
|
inline |
Implements the runtime type system interface for this class.
Constructor: Create a field with name name to manage a vector of 4 double values interpreted as plane.
Definition at line 2182 of file mlFields.h.
Member Function Documentation
◆ getPlaneValue() [1/3]
| Plane ml::PlaneField::getPlaneValue | ( | ) | const |
Returns the value of the field.
◆ getPlaneValue() [2/3]
| void ml::PlaneField::getPlaneValue | ( | double & | f0, |
| double & | f1, | ||
| double & | f2, | ||
| double & | f3 ) const |
Returns the value of the field.
◆ getPlaneValue() [3/3]
| void ml::PlaneField::getPlaneValue | ( | Plane & | plane | ) | const |
Returns the value of the field.
◆ setPlaneValue() [1/2]
| void ml::PlaneField::setPlaneValue | ( | const Plane & | p | ) |
Set field value to p.
◆ setPlaneValue() [2/2]
| void ml::PlaneField::setPlaneValue | ( | double | f0, |
| double | f1, | ||
| double | f2, | ||
| double | f3 ) |
Set field value to (f0, f1, f2, f3).
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlFields.h
