Navigation
API > API/Plugins > API/Plugins/ChaosVD
Selection handle that holds a reference to the selected solver data
| Name | FChaosVDSolverDataSelectionHandle |
| Type | struct |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/ChaosVDSolverDataSelection.h |
| Include Path | #include "ChaosVDSolverDataSelection.h" |
Syntax
struct FChaosVDSolverDataSelectionHandle : public TSharedFromThis< FChaosVDSolverDataSelectionHandle >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FChaosVDSolverDataSelectionHandle
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FChaosVDSolverDataSelectionHandle() |
ChaosVDSolverDataSelection.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataSharedPtr | TSharedPtr< void > | ChaosVDSolverDataSelection.h | ||
| SelectedDataContext | TSharedPtr< FStructOnScope > | ChaosVDSolverDataSelection.h | ||
| SelectedDataContextSharedPtr | TSharedPtr< void > | ChaosVDSolverDataSelection.h | ||
| SelectedDataStruct | TSharedPtr< FStructOnScope > | ChaosVDSolverDataSelection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ContextDataStructType * GetContextData() |
Returns a raw ptr to the context data this handled references | ChaosVDSolverDataSelection.h | |
virtual TSharedPtr< FStructOnScope > GetCustomDataReadOnlyStructViewForDetails() |
Returns a struct on Scope view that can be fed into a CVD details panel - Usually used to combine data and context into a single read only struct that can be inspected | ChaosVDSolverDataSelection.h | |
DataStructType * GetData() |
Returns a raw ptr to the data this handled references | ChaosVDSolverDataSelection.h | |
TSharedPtr< DataStructType > GetDataAsShared() |
Returns a shared ptr to the data this handled references | ChaosVDSolverDataSelection.h | |
TSharedPtr< FStructOnScope > GetDataAsStructScope() |
Returns the referenced data as FStructOnScope, so it can be feeded directly to a struct details panel | ChaosVDSolverDataSelection.h | |
bool IsA() |
Returns true if the data referenced by this handle is from the specified type | ChaosVDSolverDataSelection.h | |
virtual bool IsSelected() |
Returns tru if the data from this selection handle is currently selected | ChaosVDSolverDataSelection.h | |
bool IsValid() |
Return true if this handle is valid | ChaosVDSolverDataSelection.h | |
void SetHandleContext
(
ContextDataStructType&& ContextData |
Set the data that acts as context for this handle | ChaosVDSolverDataSelection.h | |
void SetHandleData
(
const TSharedPtr< DataStructType >& Data |
Set the data this handle points to | ChaosVDSolverDataSelection.h | |
void SetOwner
(
const TSharedPtr< FChaosVDSolverDataSelection >& InOwner |
Sets the selection system instance that owns this handle | ChaosVDSolverDataSelection.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FChaosVDSolverDataSelectionHandle& Other |
ChaosVDSolverDataSelection.h | ||
bool operator==
(
const FChaosVDSolverDataSelectionHandle& Other |
ChaosVDSolverDataSelection.h |