NodeDelegateAttributeDelegate
- class NodeDelegateAttributeDelegate
Methods
Return true is the attribute accepts overrides.
Add add override.
channel()If this attribute has a single channel, return it, return nullptr otherwise.
channels()Return all the attribute's channels.
create_observer(func, in_interactive)Return an observer which will call the func function when the attribute is possibly modified.
Return the description for this attribute (see Plug description).
Return true if this attribute has a dedicated node delegate to traverse its structure.
Return true is the attribute is animable.
Return true is the attribute can be modified.
Return true is the attribute is overridden.
is_plug()Return true if this attribute is a Rumba Plug.
Return true is the attribute is visible.
name()Return the attribute name.
Return the dedicated node delegate.
owner()Returns the owner node.
plug()Return the plug behind this attribute.
Remove the override.
set_value(value, mc)Set the attribute value.
Get the attribute type name, without evaluating the attribute.
value(qc)Return the attribute value.
- __init__(*args, **kwargs)
- accepts_overrides() bool
Return true is the attribute accepts overrides.
The default implementation returns false.
- Return type
bool
- add_override() None
Add add override.
The default implementation does nothing.
- channel() Channel
If this attribute has a single channel, return it, return nullptr otherwise.
- Return type
channel(sc: ChannelType) -> Channel
Return the specified channel if available, return nullptr otherwise.
- Return type
channel() -> Channel
If this attribute has a single channel, return it, return nullptr otherwise.
- Return type
channel(sc: ChannelType) -> Channel
Return the specified channel if available, return nullptr otherwise.
- Return type
- create_observer(func, in_interactive: bool) Observer
Return an observer which will call the func function when the attribute is possibly modified.
The observer is called when the attribute is modified. It may be called more than necessary in some implementation, like with the Values’s attributes.
To stop the function to be called, un-reference the Observer shared pointer.
If no observer can be created, returns nullptr.
- Return type
Observer
- description() AttributeDescriptor
Return the description for this attribute (see Plug description).
- Return type
- has_node_delegate() bool
Return true if this attribute has a dedicated node delegate to traverse its structure.
The default implementation returns false
- Return type
bool
- is_animable() bool
Return true is the attribute is animable.
The default implementation returns false.
- Return type
bool
- is_mutable() bool
Return true is the attribute can be modified.
The default implementation returns false.
- Return type
bool
- is_overridden() bool
Return true is the attribute is overridden.
The default implementation returns false.
- Return type
bool
- is_plug() bool
Return true if this attribute is a Rumba Plug.
- Return type
bool
- is_visible() bool
Return true is the attribute is visible.
The default implementation returns true.
- Return type
bool
- name() unicode
Return the attribute name.
- Return type
unicode
- node_delegate() NodeDelegate
Return the dedicated node delegate.
Implemented by the plug-in.
- Return type
- owner() NodeDelegate
Returns the owner node.
Implemented by the plug-in.
- Return type
- plug() Plug
Return the plug behind this attribute.
- Return type
- Raises
RuntimeError – if the attribute is not mapped to a Plug
- remove_override() None
Remove the override.
The default implementation does nothing.
- set_value(value: Value, mc: ModificationContext) None
Set the attribute value.
- type_name() StringView
Get the attribute type name, without evaluating the attribute.
- Return type
StringView
- value(qc: QueryContext) Value
Return the attribute value.
- Return type