1. Epic GamesDeveloper
  3. UConstraintsScriptingLibrary

UConstraintsScriptingLibrary

This is a set of helper functions to access various parts of the Sequencer and Control Rig API via Python and Blueprints.

API > API/Runtime > API/Runtime/Constraints

Inheritance Hierarchy

References

   
Module Constraints
Header /Engine/Source/Runtime/Experimental/Animation/Constraints/Public/ConstraintsScripting.h
Include #include "ConstraintsScripting.h"

Syntax

class UConstraintsScriptingLibrary : public UBlueprintFunctionLibrary

Remarks

This is a set of helper functions to access various parts of the Sequencer and Control Rig API via Python and Blueprints.

Functions

  Type Name Description
Public function Static bool

AddConstraint ( UWorld* InWorld,
UTransformableHandle* InParentHandle,
UTransformableHandle* InChildHandle,
UTickableTransformConstraint* InConstraint,
const bool bMaintainOffset
)

 Add Constraint to the system using the incoming parent and child handles with the specified type.
Public function Static UTickableTransformConstraint *

CreateFromType ( UWorld* InWorld,
const ETransformConstraintType InType
)

 Create Constraint based on the specified type.
Public function Static UTransformableComponentHandle *

CreateTransformableComponentHandle ( UWorld* InWorld,
USceneComponent* InSceneComponent,
const FName& InSocketName
)

 Create the transformable handle that deals with getting and setting transforms on this scene component
Public function Static UTransformableHandle *

CreateTransformableHandle ( UWorld* InWorld,
UObject* InObject,
const FName& InAttachmentName
)

 Create the transformable handle that deals with getting and setting transforms on this object
Public function Static TArray< UTickableConstraint * > Get a copy of the constraints in the current world
Public function Static UConstraintsManager *

GetManager ( UWorld* InWorld
)

 Get the manager of the constraints.
Public function Static bool

RemoveConstraint ( UWorld* InWorld,
int32 InIndex
)

 Remove constraint at specified index
Public function Static bool

RemoveThisConstraint ( UWorld* InWorld,
UTickableConstraint* InTickableConstraint
)

 Remove specified constraint

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page