Inventory Engine v4.2
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.Tools.MMPropertyLink Class Referenceabstract

A class, meant to be extended, used to control a MMProperty and get/set its value. More...

Inherited by MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkQuaternion, MoreMountains.Tools.MMPropertyLinkString, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

Public Member Functions

virtual void Initialization (MMProperty property)
 Initialization method.
virtual void CreateGettersAndSetters (MMProperty property)
 A method used to cache getter and setter for properties, not fields (sadly)
virtual float GetLevel (MMPropertyEmitter emitter, MMProperty property)
 Gets the "level" of the property, a normalized float value, caching the operation if possible.
virtual float GetLevel (MMPropertyReceiver receiver, MMProperty property)
virtual void SetLevel (MMPropertyReceiver receiver, MMProperty property, float level)
 Sets the property's level, float normalized, caching the operation if possible.
virtual object GetValue (MMPropertyEmitter emitter, MMProperty property)
 Gets the raw value of the property, a normalized float value, caching the operation if possible.
virtual void SetValue (MMPropertyReceiver receiver, MMProperty property, object newValue)
 Sets the raw property value, float normalized, caching the operation if possible.
virtual object GetPropertyValue (MMProperty property)
 Returns the value of the selected property.

Protected Member Functions

virtual void SetPropertyValue (MMProperty property, object newValue)
 Sets the value of the selected property.

Protected Attributes

bool _getterSetterInitialized = false

Detailed Description

A class, meant to be extended, used to control a MMProperty and get/set its value.

Member Function Documentation

◆ CreateGettersAndSetters()

virtual void MoreMountains.Tools.MMPropertyLink.CreateGettersAndSetters ( MMProperty property)
virtual

A method used to cache getter and setter for properties, not fields (sadly)

Parameters
property

Reimplemented in MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkQuaternion, MoreMountains.Tools.MMPropertyLinkString, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

◆ GetLevel() [1/2]

virtual float MoreMountains.Tools.MMPropertyLink.GetLevel ( MMPropertyEmitter emitter,
MMProperty property )
virtual

Gets the "level" of the property, a normalized float value, caching the operation if possible.

Parameters
emitter
property
Returns

Reimplemented in MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkQuaternion, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

◆ GetLevel() [2/2]

virtual float MoreMountains.Tools.MMPropertyLink.GetLevel ( MMPropertyReceiver receiver,
MMProperty property )
virtual

Reimplemented in MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

◆ GetPropertyValue()

virtual object MoreMountains.Tools.MMPropertyLink.GetPropertyValue ( MMProperty property)
virtual

Returns the value of the selected property.

Returns

◆ GetValue()

virtual object MoreMountains.Tools.MMPropertyLink.GetValue ( MMPropertyEmitter emitter,
MMProperty property )
virtual

Gets the raw value of the property, a normalized float value, caching the operation if possible.

Parameters
emitter
property
Returns

Reimplemented in MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkQuaternion, MoreMountains.Tools.MMPropertyLinkString, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

◆ Initialization()

virtual void MoreMountains.Tools.MMPropertyLink.Initialization ( MMProperty property)
virtual

Initialization method.

Parameters
property

Reimplemented in MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkQuaternion, MoreMountains.Tools.MMPropertyLinkString, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

◆ SetLevel()

virtual void MoreMountains.Tools.MMPropertyLink.SetLevel ( MMPropertyReceiver receiver,
MMProperty property,
float level )
virtual

Sets the property's level, float normalized, caching the operation if possible.

Parameters
receiver
property
level

Reimplemented in MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkQuaternion, MoreMountains.Tools.MMPropertyLinkString, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

◆ SetPropertyValue()

virtual void MoreMountains.Tools.MMPropertyLink.SetPropertyValue ( MMProperty property,
object newValue )
protectedvirtual

Sets the value of the selected property.

Parameters
newValue

◆ SetValue()

virtual void MoreMountains.Tools.MMPropertyLink.SetValue ( MMPropertyReceiver receiver,
MMProperty property,
object newValue )
virtual

Sets the raw property value, float normalized, caching the operation if possible.

Parameters
receiver
property
level

Reimplemented in MoreMountains.Tools.MMPropertyLinkBool, MoreMountains.Tools.MMPropertyLinkColor, MoreMountains.Tools.MMPropertyLinkFloat, MoreMountains.Tools.MMPropertyLinkInt, MoreMountains.Tools.MMPropertyLinkQuaternion, MoreMountains.Tools.MMPropertyLinkString, MoreMountains.Tools.MMPropertyLinkVector2, MoreMountains.Tools.MMPropertyLinkVector3, and MoreMountains.Tools.MMPropertyLinkVector4.

Member Data Documentation

◆ _getterSetterInitialized

bool MoreMountains.Tools.MMPropertyLink._getterSetterInitialized = false
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.14.0