omni::graph::core::IVariable_abi
Defined in omni/graph/core/IVariable.h
Inheritance Relationships
Base Type
public omni::core::Inherits< omni::core::IObject, OMNI_TYPE_ID("omni.graph.core.IVariable")>
-
class IVariable_abi : public omni::core::Inherits<omni::core::IObject, OMNI_TYPE_ID("omni.graph.core.IVariable")>
Object that contains a value that is local to a graph, available from anywhere in the graph.
Protected Functions
-
virtual const char *getName_abi() noexcept = 0
Returns the name of the variable object.
The name is derived by removing any variable specific prefixes from the underlying attribute.
- Returns
The name of the variable.
-
virtual const char *getSourcePath_abi() noexcept = 0
Returns the full path to the variables underlying attribute.
- Returns
The full usd path of the variable
-
virtual Type getType_abi() noexcept = 0
Returns the type of the variable.
- Returns
The type of the variable
-
virtual const char *getCategory_abi() noexcept = 0
Returns the category of the variable.
- Returns
The category of the variable, or an empty string if it is not set.
-
virtual void setCategory_abi(const char *category) noexcept = 0
Sets the category of the variable.
- Parameters
category – [in] A string representing the variable category
-
virtual const char *getDisplayName_abi() noexcept = 0
Gets the display name of the variable.
By default the display name is the same as the variable name.
- Returns
The display name of the variable, or an empty string if it is not set.
-
virtual void setDisplayName_abi(const char *displayName) noexcept = 0
Set the display name of the variable.
- Parameters
displayName – [in] A string to set the display name to
-
virtual const char *getTooltip_abi() noexcept = 0
Get the tooltip used for the variable.
- Returns
The tooltip of the variable, or an emtpy string if none is set.
-
virtual void setTooltip_abi(const char *toolTip) noexcept = 0
Set the tooltip used for the variable.
- Parameters
toolTip – [in] A description used as a tooltip.
-
virtual eVariableScope getScope_abi() noexcept = 0
Get the scope of the variable.
The scope determines which graphs can read and write the value.
- Returns
The scope of the variable.
-
virtual void setScope_abi(eVariableScope scope) noexcept = 0
Sets the scope of the variable.
- Parameters
scope – [in] The scope to set on the variable.
-
virtual bool isValid_abi() noexcept = 0
Returns whether this variable is valid.
- Returns
True if the variable is valid, false otherwise
-
virtual const char *getName_abi() noexcept = 0