#include <mlFields.h>

Inheritance diagram for ml::ColorField:

Public Member Functions
	ColorField ()
	Implements the runtime type system interface for this class.
	ColorField (const std::string &name)
void	setColorValue (float r, float g, float b)
	Sets the field value to `r`, `g`, and `b`.
void	updateColorValue (float r, float g, float b)
void	getColorValue (float &r, float &g, float &b) const
	Returns the value of the field into the floats `r`, `g`, and `b`.
const Vector3 &	getColorValue () const
	Returns the value of the field as a Vector3.
void	setPackedColorValue (MLuint32 rgba)
MLuint32	getPackedColorValue () const
Public Member Functions inherited from ml::Vector3Field
	Vector3Field ()=default
	Implements the runtime type system interface for this class.
	Vector3Field (const std::string &name)
void	setStringValue (const std::string &stringValue) override
	Sets the value of the field to `stringValue`.
void	setVector3Value (const Vector3 &vectorValue)
	Sets the value of the field to `vectorValue`.
void	updateVector3Value (const Vector3 &vectorValue)
void	setVectorValue (const Vector3 &vectorValue)
	Sets the value of the field to `vectorValue`.
std::string	getStringValue () const override
const Vector3 &	getVector3Value () const
	Returns the value of the field.
const Vector3 &	getVectorValue () const
	Returns the value of the field.
void	setValue (const Vector3 &vectorValue)
	Same as setVector3Value().
void	updateValue (const Vector3 &vectorValue)
	Same as updateVector3Value().
const Vector3 &	getValue () const
	Same as getVector3Value().
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 ()

Additional Inherited Members
static void	enableNotificationsGlobally (bool flag)
static bool	areNotificationsEnabledGlobally ()
static MLint &	enableNotificationsCounterState ()
Protected Member Functions inherited from ml::Vector3Field
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.
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 to encapsulate a vector of three float values representing an (RGB) color with all properties of Vector3Field.

Definition at line 1331 of file mlFields.h.

Constructor & Destructor Documentation

◆ ColorField() [1/2]

ml::ColorField::ColorField ( )

Implements the runtime type system interface for this class.

Default constructor, do not use it.

◆ ColorField() [2/2]

ml::ColorField::ColorField ( const std::string & name )

explicit

Constructor; creates a field with a name to manage a vector of three float values interpreted as RGB-color values without transparency. Default value is (0,0,0).

Member Function Documentation

◆ getColorValue() [1/2]

const Vector3 & ml::ColorField::getColorValue ( ) const

inline

Returns the value of the field as a Vector3.

Definition at line 1358 of file mlFields.h.

References ml::Vector3Field::getVectorValue().

◆ getColorValue() [2/2]

void ml::ColorField::getColorValue	(	float &	r,
		float &	g,
		float &	b ) const

Returns the value of the field into the floats r, g, and b.

◆ getPackedColorValue()

MLuint32 ml::ColorField::getPackedColorValue ( ) const

Returns the packed uint32 color value. Last (alpha) value is always set to opaque in bits 24 to 31. Red is read from the lowest 8 bits, green from bits 8-15, and blue from the bits 16 to 23.

◆ setColorValue()

void ml::ColorField::setColorValue	(	float	r,
		float	g,
		float	b )

Sets the field value to r, g, and b.

◆ setPackedColorValue()

void ml::ColorField::setPackedColorValue ( MLuint32 rgba )

Sets the packed uint32 color value to rgba. Last (alpha) value from bits 24 to 31 is ignored; red is read from the lowest 8 bits, green from bits 8-15, and blue from the bits 16 to 23. Values are normalized then from ranges [0,255] to range [0,1] and stored as floating point values.

◆ updateColorValue()

void ml::ColorField::updateColorValue	(	float	r,
		float	g,
		float	b )

Sets the field value to r, g, and b, 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!

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

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

Public Member Functions

Additional Inherited Members