ml::Vector2ListField Class Reference
#include <mlListFields.h>
Inheritance diagram for ml::Vector2ListField:
Public Member Functions | |
| Vector2ListField () | |
| Implements the runtime type system interface for this class. | |
| Vector2ListField (const std::string &name) | |
Constructor; creates a multi-field with a name. | |
| Public Member Functions inherited from ml::ListField< Vector2 > | |
| ListField ()=default | |
| Default constructor, do not use it. | |
| size_t | size () const |
| Returns the number of elements of this fields value. | |
| void | clear () |
| Clears the value of this field. | |
| void | setValues (const std::vector< Vector2 > &values) |
Sets the field value to values. | |
| void | updateValues (const std::vector< Vector2 > &values) |
| std::vector< Vector2 > | getValues () const |
| Returns the value of the field as a boolean. | |
| void | setValueAt (size_t index, Vector2 value) |
| void | updateValueAt (size_t index, Vector2 value) |
| Vector2 | getValueAt (size_t index) const |
Returns component value at index index. index must be in range. | |
| std::string | getStringValue () const override |
| Returns the value of the field as string value. | |
| void | setStringValue (const std::string &value) override |
Sets the value of the field to value. | |
| 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
Definition at line 72 of file mlListFields.h.
Constructor & Destructor Documentation
◆ Vector2ListField() [1/2]
| ml::Vector2ListField::Vector2ListField | ( | ) |
Implements the runtime type system interface for this class.
Default constructor, do not use it.
◆ Vector2ListField() [2/2]
| ml::Vector2ListField::Vector2ListField | ( | const std::string & | name | ) |
Constructor; creates a multi-field with a name.
Member Function Documentation
◆ setValueFromField()
|
overrideprotectedvirtual |
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlListFields.h
