Navigation
API > API/Plugins > API/Plugins/ChaosVD
Structure that represents a specific mesh instance on a CVD Mesh component (instanced or static)
| Name | FChaosVDInstancedMeshData |
| Type | class |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/ChaosVDGeometryDataComponent.h |
| Include Path | #include "ChaosVDGeometryDataComponent.h" |
Syntax
class FChaosVDInstancedMeshData : public TSharedFromThis< FChaosVDInstancedMeshData >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FChaosVDInstancedMeshData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosVDInstancedMeshData
(
int32 InInstanceIndex, |
ChaosVDGeometryDataComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFailedToUpdateShapeInstanceData | bool | Used only for debugging purposes - It will be set to true if we received new Shape Instance data but the Shape Index for the implicit object we represent is not valid | ChaosVDGeometryDataComponent.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsPendingDestroy | bool | ChaosVDGeometryDataComponent.h | ||
| ExtractedGeometryHandle | TSharedRef< FChaosVDExtractedGeometryDataHandle > | ChaosVDGeometryDataComponent.h | ||
| GeometryBuilderInstance | TWeakPtr< FChaosVDGeometryBuilder > | ChaosVDGeometryDataComponent.h | ||
| InstanceState | FChaosVDMeshDataInstanceState | ChaosVDGeometryDataComponent.h | ||
| UChaosVDInstancedStaticMeshComponent | friend | ChaosVDGeometryDataComponent.h | ||
| UChaosVDStaticMeshComponent | friend | ChaosVDGeometryDataComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TWeakPtr< FChaosVDGeometryBuilder > GetGeometryBuilder() |
ChaosVDGeometryDataComponent.h | ||
FChaosVDShapeCollisionData & GetGeometryCollisionData() |
Returns the current shape collision data to this mesh instance | ChaosVDGeometryDataComponent.h | |
const TSharedRef< FChaosVDExtractedGeometryDataHandle > & GetGeometryHandle() |
Returns the geometry handle used to create the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
FLinearColor GetInstanceColor() |
Returns the current color of the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
UMeshComponent * GetMeshComponent() |
Returns the mesh component used to render the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
EChaosVDMeshComponent GetMeshComponentType() |
Returns the type of the component used to render the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
int32 GetMeshInstanceIndex() |
Returns the instance index of the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
int32 GetOwningParticleID() |
Returns the Particle ID of the particle owning this mesh instance | ChaosVDGeometryDataComponent.h | |
int32 GetOwningSolverID() |
Returns the Solver ID of the particle owning this mesh instance | ChaosVDGeometryDataComponent.h | |
FChaosVDMeshDataInstanceState & GetState() |
ChaosVDGeometryDataComponent.h | ||
bool GetVisibility() |
Returns the current visibility state this mesh instance | ChaosVDGeometryDataComponent.h | |
const FTransform & GetWorldTransform() |
Returns the world transform of the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
bool IsPendingDestroy() |
Returns true if this instance is queued to be destroyed | ChaosVDGeometryDataComponent.h | |
void MarkPendingDestroy() |
Marks a instance that is queued to be destroyed at the end of the frame | ChaosVDGeometryDataComponent.h | |
void SetGeometryBuilder
(
const TWeakPtr< FChaosVDGeometryBuilder >& InGeometryBuilder |
Sets a Ptr to the geometry builder used to generate and manage the geometry/mesh components this handle represents | ChaosVDGeometryDataComponent.h | |
void SetGeometryCollisionData
(
const FChaosVDShapeCollisionData&& InCollisionData |
Applies a new shape collision data to this mesh instance | ChaosVDGeometryDataComponent.h | |
void SetInstanceColor
(
const FLinearColor& NewColor |
Applies to the provided color to the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
void SetIsSelected
(
bool bInIsSelected |
Marks this mesh instance as selected. Used to handle Selection in Editor | ChaosVDGeometryDataComponent.h | |
void SetMeshInstanceIndex
(
int32 NewIndex |
Sets the mesh instance index of the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
void SetVisibility
(
bool bInIsVisible |
Sets the visibility of this mesh instance | ChaosVDGeometryDataComponent.h | |
void SetWorldTransform
(
const FTransform& InTransform |
Applies the provided world transform to the mesh instance this handle represents | ChaosVDGeometryDataComponent.h | |
void UpdateMeshComponentForCollisionData
(
const FChaosVDShapeCollisionData& InCollisionData |
Applies to the provided shape collision data to the mesh instance this handle represents | ChaosVDGeometryDataComponent.h |