Navigation
API > API/Plugins > API/Plugins/ChaosVD
Base Class for any UStruct based object that has a representation in CVD's World and outliner
| Name | FChaosVDBaseSceneObject |
| Type | struct |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/ChaosVDBaseSceneObject.h |
| Include Path | #include "ChaosVDBaseSceneObject.h" |
Syntax
USTRUCT ()
struct FChaosVDBaseSceneObject
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FChaosVDBaseSceneObject() |
ChaosVDBaseSceneObject.h |
Enums
Public
| Name | Remarks |
|---|---|
| EStreamingState |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetDisplayName() |
Returns a copy the name that will be used for this object in the scene outliner | ChaosVDBaseSceneObject.h | |
const FString & GetDisplayNameRef() |
Returns a reference to the name that will be used for this object in the scene outliner | ChaosVDBaseSceneObject.h | |
FName GetIconName() |
Returns the registered name of the icon that will be shown as part of the label for this object in the scene outliner | ChaosVDBaseSceneObject.h | |
TWeakPtr< FChaosVDBaseSceneObject > GetParent() |
Returns a weak ptr to this object's parent | ChaosVDBaseSceneObject.h | |
AActor * GetParentActor() |
Returns a weak ptr to this object's parent Actor | ChaosVDBaseSceneObject.h | |
virtual FBox GetStreamingBounds() |
ChaosVDBaseSceneObject.h | ||
virtual int32 GetStreamingID() |
ChaosVDBaseSceneObject.h | ||
EStreamingState GetStreamingState() |
ChaosVDBaseSceneObject.h | ||
UE::Editor::DataStorage::RowHandle GetTedsRowHandle() |
Returns the handle for this object in TEDS | ChaosVDBaseSceneObject.h | |
void SetDisplayName
(
const FString& NewDisplayName |
Sets the name that will be used for this object in the scene outliner | ChaosVDBaseSceneObject.h | |
void SetIconName
(
FName NewIconName |
Sets the name of the icon that will be shown as part of the label for this object in the scene outliner | ChaosVDBaseSceneObject.h | |
virtual void SetParent
(
const TSharedPtr< FChaosVDBaseSceneObject >& NewParent |
Sets a weak reference to another UStruct based scene object, that is the parent of this object | ChaosVDBaseSceneObject.h | |
void SetParentParentActor
(
AActor* NewParent |
Sets a weak reference to an actor that is the parent of this object. | ChaosVDBaseSceneObject.h | |
void SetStreamingState
(
EStreamingState NewState |
ChaosVDBaseSceneObject.h | ||
void SetTedsRowHandle
(
UE::Editor::DataStorage::RowHandle Handle |
Sets the handle for this object in TEDS | ChaosVDBaseSceneObject.h | |
virtual void SyncStreamingState() |
ChaosVDBaseSceneObject.h |