Navigation
API > API/Plugins > API/Plugins/ChaosVD
Structure that acts as a handle to access the generated static mesh of a implicit object, plus other data extracted from it
| Name | FChaosVDExtractedGeometryDataHandle |
| Type | struct |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/ChaosVDExtractedGeometryDataHandle.h |
| Include Path | #include "ChaosVDExtractedGeometryDataHandle.h" |
Syntax
struct FChaosVDExtractedGeometryDataHandle
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataComponentKey | uint32 | Key to be used to match this geometry with recorded Shape Data | ChaosVDExtractedGeometryDataHandle.h | |
| GeometryKey | uint32 | Key representing the generated static mesh | ChaosVDExtractedGeometryDataHandle.h | |
| ImplicitObject | const Chaos::FImplicitObject * | The Implicit Object Ptr from which the data was extracted and the mesh was generated | ChaosVDExtractedGeometryDataHandle.h | |
| RootImplicitObject | const Chaos::FImplicitObject * | If the object was an union and this was a leaf, this will be the root union object, otherwise it will be the same as ImplicitObject | ChaosVDExtractedGeometryDataHandle.h | |
| ShapeInstanceIndex | int32 | Index on which this Implicit object was in the Hierarchy of the root one | ChaosVDExtractedGeometryDataHandle.h | |
| Transform | FTransform | Extracted transform of the generated implicit object in component space | ChaosVDExtractedGeometryDataHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetDataComponentKey() |
Key to be used to match this geometry with recorded Shape Data | ChaosVDExtractedGeometryDataHandle.h | |
uint32 GetGeometryKey() |
Key representing the generated static mesh - Handles for different implicit objects can point to the same geometry key, if after being unpacked they result in essentially the same mesh | ChaosVDExtractedGeometryDataHandle.h | |
const Chaos::FImplicitObject * GetImplicitObject() |
Ptr to the implicit object this handle provides access to and from which the mesh was generated | ChaosVDExtractedGeometryDataHandle.h | |
const FTransform & GetRelativeTransform() |
Extracted transform of the generated implicit object in component space | ChaosVDExtractedGeometryDataHandle.h | |
const Chaos::FImplicitObject * GetRootImplicitObject() |
If the object was an union and this was a leaf, this getter returns the root union object, otherwise it will be the same as GetImplicitObject | ChaosVDExtractedGeometryDataHandle.h | |
int32 GetShapeInstanceIndex() |
Returns the Index to correct the shape data instance in the shape instances array of the particle that owns this geometry | ChaosVDExtractedGeometryDataHandle.h | |
FName GetTypeName() |
Name of the type this underlying implicit object this instance represents | ChaosVDExtractedGeometryDataHandle.h | |
void SetDataComponentKey
(
const uint32 Key |
ChaosVDExtractedGeometryDataHandle.h | ||
void SetGeometryKey
(
const uint32 Key |
ChaosVDExtractedGeometryDataHandle.h | ||
void SetImplicitObject
(
const Chaos::FImplicitObject* InImplicitObject |
Sets the Implicit Object Ptr from which the data was extracted and the mesh was generated | ChaosVDExtractedGeometryDataHandle.h | |
void SetRootImplicitObject
(
const Chaos::FImplicitObject* InImplicitObject |
Sets the Implicit Object Ptr from which the data was extracted and the mesh was generated | ChaosVDExtractedGeometryDataHandle.h | |
void SetShapeInstanceIndex
(
int32 InObjectIndex |
Sets the Index on which this Implicit object was in the Hierarchy of the root one | ChaosVDExtractedGeometryDataHandle.h | |
void SetTransform
(
const FTransform& InTransform |
ChaosVDExtractedGeometryDataHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FChaosVDExtractedGeometryDataHandle& Other |
ChaosVDExtractedGeometryDataHandle.h |