Triple (hwx.inspire.core)¶
Store 3 float values.
Base class for Color, Direction, Location.
Public Methods¶
castForGet (self, obj, value)
castForSet (self, obj, value)
create (self, obj)
createList (self, listAttr, obj)
createListList (self, listAttr, obj)
disable (self, obj)
enable (self, obj)
getCreateArgs (self)
getDisplayName (self, obj)
getGuiValue (self, obj, component=None, **kwds)
getInCoreValue (self, obj)
getUnits (self, obj)
getValue (self, obj)
getValueList (self, obj)
getValueListList (self, obj)
initialize (self, objCls, name)
loadValue (self, obj, value)
setInCoreValue (self, obj, value)
setValue (self, obj, value)
setValueList (self, obj, value)
setValueListList (self, obj, value)
Method Details¶
- classmethod apply(cls, **kwds)¶
Context manager to specify Attribute constructor kwds Useful to avoid repeating kwds while defining a related group
- castForGet(self, obj, value)¶
Converts and returns the triple value to gui units.
- castForSet(self, obj, value)¶
Converts and validates the triple value before setting.
- param obj
Object this attribute belongs to.
- type obj
GeneralObject
- param value
Value of the attribute to set.
- type value
str | list[float]
- returns
Validated and converted value.
- rtype
math.Vector
- create(self, obj)¶
Creates a triple attribute for the specified object.
- createList(self, listAttr, obj)¶
Creates an attribute that has list of values for the specified object.
- createListList(self, listAttr, obj)¶
Creates an attribute that has nested list of values for the specified object.
- disable(self, obj)¶
Disables the attribute.
- enable(self, obj)¶
Enables the attribute.
- getCreateArgs(self)¶
Helper used in create methods
- getDisplayName(self, obj)¶
Returns the display name of the attribute.
Display name is used show the objects attribute name in the Property editor.
- getGuiValue(self, obj, component=None, **kwds)¶
Formats the triple value to display it in the Property Editor.
- param obj
Object to get triple value from.
- type obj
GeneralObject
- param component
Specifies which component of the triple is needs formatting. Component can be ‘x’, ‘y’ or ‘z’.
- type component
str
- returns
Formatted triple value.
- rtype
str
- getInCoreValue(self, obj)¶
Calls the incore get method (defined in C++) of the attribute.
- param obj
Object this attribute belongs to.
- type obj
GeneralObject
- param value
Value of the attribute to get.
- type value
Any
- returns
Value returned by the incore get method.
- rtype
Any
- getUnits(self, obj)¶
Returns the units of the attribute.
- getValue(self, obj)¶
Returns the triple value for the specified object.
- getValueList(self, obj)¶
Returns the list of values from the specified object.
- getValueListList(self, obj)¶
Returns the nested list of values from the specified object.
- initialize(self, objCls, name)¶
Initializes the attribute.
- param objCls
Object class this attribute belongs to.
- type objCls
class
- param name
Name of the attribute.
- type name
str
- loadValue(self, obj, value)¶
Loads and sets the value, when a model is loaded.
- setInCoreValue(self, obj, value)¶
Calls the incore set method (defined in C++) of the attribute.
- param obj
Object this attribute belongs to.
- type obj
GeneralObject
- param value
Value of the attribute to set.
- type value
Any
- setValue(self, obj, value)¶
Sets the triple value for the specified object.
- setValueList(self, obj, value)¶
Sets the specified list of values for the attribute.
- setValueListList(self, obj, value)¶
Sets the specified nested list of values for the attribute.