URig Hierarchy

URig Hierarchy

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Contains

Returns true if the provided element key is valid

Target is Rig Hierarchy

Copy Hierarchy

Copies the contents of a hierarchy onto this one

Target is Rig Hierarchy

Copy Pose

Copies the contents of a hierarchy onto this one

Target is Rig Hierarchy

Find Bone

Returns bone element for a given key, for scripting purpose only, for cpp usage, use Find<FRigBoneElement>()

Target is Rig Hierarchy

Find Control

Returns control element for a given key, for scripting purpose only, for cpp usage, use Find<FRigControlElement>()

Target is Rig Hierarchy

Find Null

Returns null element for a given key, for scripting purpose only, for cpp usage, use Find<FRigControlElement>()

Target is Rig Hierarchy

Get All Keys

Returns all element keys of this hierarchy

Target is Rig Hierarchy

Get Bones

Returns all Bone elements

Target is Rig Hierarchy

Get Children

Returns the child elements of a given element key

Target is Rig Hierarchy

Get Control Value

Returns a control's current value given its key

Target is Rig Hierarchy

Get Control Value by Index

Returns a control's current value given its index

Target is Rig Hierarchy

Get Controller

Returns a controller for this hierarchy

Target is Rig Hierarchy

Get Controls

Returns all Control elements

Target is Rig Hierarchy

Get Curve Value

Returns a curve's value given its key

Target is Rig Hierarchy

Get Curve Value by Index

Returns a curve's value given its index

Target is Rig Hierarchy

Get Curves

Returns all Curve elements

Target is Rig Hierarchy

Get Euler Transform from Control Value

Returns the contained FEulerTransform value from a a Rig Control Value

Target is Rig Hierarchy

Get First Parent

Returns the first parent element of a given element key

Target is Rig Hierarchy

Get Float from Control Value

Returns the contained float value from a a Rig Control Value

Target is Rig Hierarchy

Get Global Control Offset Transform

Returns the global offset transform for a given control element.

Target is Rig Hierarchy

Get Global Control Offset Transform by Index

Returns the global offset transform for a given control element.

Target is Rig Hierarchy

Get Global Control Shape Transform

Returns the global shape transform for a given control element.

Target is Rig Hierarchy

Get Global Control Shape Transform by Index

Returns the global shape transform for a given control element.

Target is Rig Hierarchy

Get Global Transform

Returns the global current or initial value for a given key. If the key is invalid FTransform::Identity will be returned.

Target is Rig Hierarchy

Get Global Transform by Index

Returns the global current or initial value for a element index. If the index is invalid FTransform::Identity will be returned.

Target is Rig Hierarchy

Get Index

Returns the index of an element given its key

Target is Rig Hierarchy

Get Int from Control Value

Returns the contained int32 value from a a Rig Control Value

Target is Rig Hierarchy

Get Key

Returns the key of an element given its index

Target is Rig Hierarchy

Get Local Transform

Returns the local current or initial value for a given key. If the key is invalid FTransform::Identity will be returned.

Target is Rig Hierarchy

Get Local Transform by Index

Returns the local current or initial value for a element index. If the index is invalid FTransform::Identity will be returned.

Target is Rig Hierarchy

Get Nulls

Returns all Null elements

Target is Rig Hierarchy

Get Number Of Parents

Returns the number of parents of an element

Target is Rig Hierarchy

Get Parent Transform

Returns the global current or initial value for a given key. If the element does not have a parent FTransform::Identity will be returned.

Target is Rig Hierarchy

Get Parent Transform by Index

Returns the global current or initial value for a given element index. If the element does not have a parent FTransform::Identity will be returned.

Target is Rig Hierarchy

Get Parent Weight

Returns the weight of a parent below a multi parent element

Target is Rig Hierarchy

Get Parent Weight Array

Returns the weights of all parents below a multi parent element

Target is Rig Hierarchy

Get Parents

Returns the parent elements of a given element key

Target is Rig Hierarchy

Get Pose

Returns the current / initial pose of the hierarchy

Target is Rig Hierarchy

Get Previous Name

Returns the previous name of an element prior to a rename operation

Target is Rig Hierarchy

Get Previous Parent

Returns the previous parent of an element prior to a reparent operation

Target is Rig Hierarchy

Get References

Returns all references

Target is Rig Hierarchy

Get RigidBodies

Returns all RigidBody elements

Target is Rig Hierarchy

Get Rotator from Control Value

Returns the contained FRotator value from a a Rig Control Value

Target is Rig Hierarchy

Get Selected Keys

Returns the keys of selected elements @InTypeFilter The types to retrieve the selection for

Target is Rig Hierarchy

Get Transform from Control Value

Returns the contained FTransform value from a a Rig Control Value

Target is Rig Hierarchy

Get Transform No Scale from Control Value

Returns the contained FTransformNoScale value from a a Rig Control Value

Target is Rig Hierarchy

Get Vector 2DFrom Control Value

Returns the contained FVector2D value from a a Rig Control Value

Target is Rig Hierarchy

Get Vector from Control Value

Returns the contained FVector value from a a Rig Control Value

Target is Rig Hierarchy

Is Parented To

Returns true if an element is parented to another element

Target is Rig Hierarchy

Is Selected

Returns true if a given element is selected

Target is Rig Hierarchy

Is Selected by Index

Returns true if a given element is selected

Target is Rig Hierarchy

Is Valid Index

Returns true if the provided element index is valid

Target is Rig Hierarchy

Make Control Value from Bool

Creates a rig control value from a bool value

Target is Rig Hierarchy

Make Control Value from Euler Transform

Creates a rig control value from a FEulerTransform value

Target is Rig Hierarchy

Make Control Value from Float

Creates a rig control value from a float value

Target is Rig Hierarchy

Make Control Value from Int

Creates a rig control value from a int32 value

Target is Rig Hierarchy

Make Control Value from Rotator

Creates a rig control value from a FRotator value

Target is Rig Hierarchy

Make Control Value from Transform

Creates a rig control value from a FTransform value

Target is Rig Hierarchy

Make Control Value from Transform No Scale

Creates a rig control value from a FTransformNoScale value

Target is Rig Hierarchy

Make Control Value from Vector

Creates a rig control value from a FVector value

Target is Rig Hierarchy

Make Control Value from Vector 2D

Creates a rig control value from a FVector2D value

Target is Rig Hierarchy

Num

Returns the number of elements in the Hierarchy.

Target is Rig Hierarchy

Reset

Clears the whole hierarchy and removes all elements.

Target is Rig Hierarchy

Reset Curve Values

Resets all curves to 0.0

Target is Rig Hierarchy

Reset Pose to Initial

Resets the current pose of a filtered lost if elements to the initial / ref pose.

Target is Rig Hierarchy

Send Auto Key Event

Sends an autokey event from the hierarchy to the world

Target is Rig Hierarchy

Set Control Offset Transform

Sets the offset transform for a given control element by key

Target is Rig Hierarchy

Set Control Offset Transform by Index

Sets the local offset transform for a given control element by index

Target is Rig Hierarchy

Set Control Settings

Sets the control settings for a given control element by key

Target is Rig Hierarchy

Set Control Settings by Index

Sets the control settings for a given control element by index

Target is Rig Hierarchy

Set Control Shape Transform

Sets the shape transform for a given control element by key

Target is Rig Hierarchy

Set Control Shape Transform by Index

Sets the local shape transform for a given control element by index

Target is Rig Hierarchy

Set Control Value

Sets a control's current value given its key

Target is Rig Hierarchy

Set Control Value by Index

Sets a control's current value given its index

Target is Rig Hierarchy

Set Control Visibility

Sets a control's current visibility based on a key

Target is Rig Hierarchy

Set Control Visibility by Index

Sets a control's current visibility based on a key

Target is Rig Hierarchy

Set Curve Value

Sets a curve's value given its key

Target is Rig Hierarchy

Set Curve Value by Index

Sets a curve's value given its index

Target is Rig Hierarchy

Set Global Transform

Sets the global current or initial transform for a given key.

Target is Rig Hierarchy

Set Global Transform by Index

Sets the global current or initial transform for a given element index.

Target is Rig Hierarchy

Set Local Transform

Sets the local current or initial transform for a given key.

Target is Rig Hierarchy

Set Local Transform by Index

Sets the local current or initial transform for a given element index.

Target is Rig Hierarchy

Set Parent Weight

Sets the weight of a parent below a multi parent element

Target is Rig Hierarchy

Set Parent Weight Array

Sets the all of the weights of the parents of a multi parent element

Target is Rig Hierarchy

Set Pose

Sets the current / initial pose of the hierarchy

Target is Rig Hierarchy

Sort Keys

Sorts the input key list by traversing the hierarchy

Target is Rig Hierarchy

Switch to Default Parent

Switches a multi parent element to its first parent

Target is Rig Hierarchy

Switch to Parent

Switches a multi parent element to a single parent. This sets the new parent's weight to 1.0 and disables weights for all other potential parents.

Target is Rig Hierarchy

Switch to World Space

Switches a multi parent element to world space. This injects a world space reference.

Target is Rig Hierarchy