1. Epic GamesDeveloper
  3. FPhysicsControlNameRecords

FPhysicsControlNameRecords

All the controls and body modifiers we create get given names, so we can keep a record in a form that will be useful to users.

API > API/Plugins > API/Plugins/PhysicsControl

References

   
Module PhysicsControl
Header /Engine/Plugins/Experimental/PhysicsControl/Source/PhysicsControl/Public/PhysicsControlNameRecords.h
Include #include "PhysicsControlNameRecords.h"

Syntax

struct FPhysicsControlNameRecords

Remarks

All the controls and body modifiers we create get given names, so we can keep a record in a form that will be useful to users. The three general uses are:

All controls or modifiers

The type of control - the obvious ones are "world space" and "parent space", but users might make others

Sets of control/modifiers - the obvious ones are limbs (e.g. a set of world-space controls on the leg) but users might want to make other sets - e.g. "UpperBody"

Variables

  Type Name Description
Public variable TMap< FName, TArray< FName > > BodyModifierSets All the body modifiers we've created, arranged by set name.
Public variable TMap< FName, TArray< FName > > ControlSets All the control sets we've created, arranged by set name.

Functions

  Type Name Description
Public function void

AddBodyModifier ( FName Name,
FName SetName
)

 Adds Name to SetName as well as adding it to the set "All"
Public function void

AddBodyModifier ( FName Name,
const TArray< FName >& SetNames
)

 Adds Name to SetNames as well as adding it to the set "All"
Public function void

AddBodyModifiers ( const TArray< FName >& BodyModifierNames,
const FName SetName
)

 Adds a collection of Names to SetName as well as adding them to the set "All"
Public function void

AddControl ( FName Name,
FName SetName
)

 Adds Name to SetName as well as adding it to the set "All"
Public function void

AddControl ( FName Name,
const TArray< FName >& SetNames
)

 Adds Name to SetNames as well as adding it to the set "All"
Public function void

AddControls ( const TArray< FName >& ControlNames,
const FName SetName
)

 Adds a collection of Names to SetName as well as adding them to the set "All"
Public function Const const TArray< FName > &

GetBodyModifierNamesInSet ( FName SetName
)

  
Public function Const const TArray< FName > &

GetControlNamesInSet ( FName SetName
)

  
Public function void

RemoveBodyModifier ( FName Name
)

 Removes Name from all Sets
Public function void

RemoveControl ( FName Name
)

 Removes Name from all Sets
Public function void

Reset ()

 Remove all control and modifier sets.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page