Navigation
API > API/Plugins > API/Plugins/ChaosVD
Base class used for all component visualizers in CVD - It provides a common code to handle selection and clicks
Not all functionality of UE's component visualizer framework is supported in CVD
| Name | FChaosVDComponentVisualizerBase |
| Type | class |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/Visualizers/ChaosVDComponentVisualizerBase.h |
| Include Path | #include "Visualizers/ChaosVDComponentVisualizerBase.h" |
Syntax
class FChaosVDComponentVisualizerBase : public FComponentVisualizer
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FComponentVisualizer → FChaosVDComponentVisualizerBase
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool VisProxyHandleClick
(
FEditorViewportClient* InViewportClient, |
Handles a click to any CVD componentvisualization hit proxy | Visualizers/ChaosVDComponentVisualizerBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanHandleClick
(
const HChaosVDComponentVisProxy& VisProxy |
Returns true if this visualizer can handle a click in the viewport | Visualizers/ChaosVDComponentVisualizerBase.h | |
| Creates a menu entry for this visualizer data, as long it is using the supporting settings format and types for visualizers | Visualizers/ChaosVDComponentVisualizerBase.h | ||
void RegisterVisualizerMenus () |
Called when the menu for this visualizer (if any) can be registered. | Visualizers/ChaosVDComponentVisualizerBase.h | |
virtual bool SelectVisualizedData
(
const HChaosVDComponentVisProxy& VisProxy, |
Selects the visualized data referenced by the provided hitproxy | Visualizers/ChaosVDComponentVisualizerBase.h |