unreal.RigVMPin
¶
-
class
unreal.
RigVMPin
(outer=None, name='None')¶ Bases:
unreal.Object
The Pin represents a single connector / pin on a node in the RigVM model. Pins can be connected based on rules. Pins also provide access to a ‘PinPath’, which essentially represents . separated list of names to reach the pin within the owning graph. PinPaths are unique. In comparison to the EdGraph Pin the URigVMPin supports the concept of ‘SubPins’, so child / parent relationships between pins. A FVector Pin for example might have its X, Y and Z components as SubPins. Array Pins will have its elements as SubPins, and so on. A URigVMPin is owned solely by a URigVMNode.
C++ Source:
Module: RigVMDeveloper
File: RigVMPin.h
-
get_array_element_cpp_type
() → str¶ Returns the C++ data type of an element of the Pin array
- Returns
- Return type
-
get_array_size
() → int32¶ Returns the number of elements within an array Pin
- Returns
- Return type
int32
-
get_cpp_type_object
() → Object¶ Returns the struct of the data type of the Pin, or nullptr otherwise.
- Returns
- Return type
-
get_custom_widget_name
() → Name¶ Returns the name of a custom widget to be used for editing the Pin.
- Returns
- Return type
-
get_default_value
() → str¶ Returns the default value of the Pin as a string. Note that this value is computed based on the Pin’s SubPins - so for example for a FVector typed Pin the default value is actually composed out of the default values of the X, Y and Z SubPins.
- Returns
- Return type
-
get_direction
() → RigVMPinDirection¶ Returns the direction of the pin
- Returns
- Return type
-
get_enum
() → Enum¶ Returns the enum of the data type of the Pin, or nullptr otherwise.
- Returns
- Return type
-
get_graph
() → RigVMGraph¶ Returns the graph of this Pin.
- Returns
- Return type
-
get_linked_source_pins
(recursive=False)¶ Returns all of the linked source Pins, using this Pin as the target.
-
get_linked_target_pins
(recursive=False)¶ Returns all of the linked target Pins, using this Pin as the source.
-
get_original_pin_from_injected_node
() → RigVMPin¶ Returns the original pin for a pin on an injected node. This can be used to determine where a link should go in the user interface
- Returns
- Return type
-
get_parent_pin
() → RigVMPin¶ Returns the parent Pin - or nullptr if the Pin is nested directly below a node.
- Returns
- Return type
-
get_pin_for_link
() → RigVMPin¶ Returns the pin to be used for a link. This might differ from this actual pin, since the pin might contain injected nodes.
- Returns
- Return type
-
get_pin_index
() → int32¶ Returns the index of the Pin within the node / parent Pin
- Returns
- Return type
int32
-
get_pin_path
() → str¶ Returns a . separated path containing all names of the pin and its owners, this includes the node name, for example “Node.Color.R”
- Returns
- Return type
-
get_root_pin
() → RigVMPin¶ Returns the top-most parent Pin, so for example for “Node.Transform.Translation.X” this returns the Pin for “Node.Transform”.
- Returns
- Return type
-
get_script_struct
() → ScriptStruct¶ Returns the struct of the data type of the Pin, or nullptr otherwise.
- Returns
- Return type
-
get_segment_path
() → str¶ Returns a . separated path containing all names of the pin within its main memory owner / storage. This is typically used to create an offset pointer within memory (FRigVMRegisterOffset). So for example for a PinPath such as “Node.Transform.Translation.X” the corresponding SegmentPath is “Translation.X”, since the transform is the storage / memory.
- Returns
- Return type
-
get_source_links
(recursive=False)¶ Returns all of the source pins using this Pin as the target.
-
get_target_links
(recursive=False)¶ Returns all of the target links, using this Pin as the source.
-
is_defined_as_constant
() → bool¶ Returns true if the pin is defined as a constant value / literal
- Returns
- Return type
-
is_execute_context
() → bool¶ Returns true if the C++ data type is an execute context
- Returns
- Return type