Open 3D Engine WhiteBox Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
WhiteBox::EditorWhiteBoxComponent Class Reference

Editor representation of White Box Tool. More...

#include <EditorWhiteBoxComponent.h>

Inherits AzToolsFramework::Components::EditorComponentBase, AzToolsFramework::EditorComponentSelectionRequestsBus::Handler, AzFramework::BoundsRequestBus::Handler, EditorWhiteBoxComponentRequestBus::Handler, EditorWhiteBoxComponentNotificationBus::Handler, AZ::TransformNotificationBus::Handler, AzFramework::EntityDebugDisplayEventBus::Handler, and AzToolsFramework::EditorVisibilityNotificationBus::Handler.

Public Member Functions

 AZ_EDITOR_COMPONENT (EditorWhiteBoxComponent, "{C9F2D913-E275-49BB-AB4F-2D221C16170A}", EditorComponentBase)
 
 EditorWhiteBoxComponent (const EditorWhiteBoxComponent &)=delete
 
EditorWhiteBoxComponent & operator= (const EditorWhiteBoxComponent &)=delete
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
WhiteBoxMesh * GetWhiteBoxMesh () override
 
void SerializeWhiteBox () override
 
void DeserializeWhiteBox () override
 
void WriteAssetToComponent () override
 
void RebuildWhiteBox () override
 
void SetDefaultShape (DefaultShapeType defaultShape) override
 
AZ::Aabb GetEditorSelectionBoundsViewport (const AzFramework::ViewportInfo &viewportInfo) override
 
bool EditorSelectionIntersectRayViewport (const AzFramework::ViewportInfo &viewportInfo, const AZ::Vector3 &src, const AZ::Vector3 &dir, float &distance) override
 
bool SupportsEditorRayIntersect () override
 
AZ::Aabb GetWorldBounds () const override
 
AZ::Aabb GetLocalBounds () const override
 
bool HasRenderMesh () const
 Returns if the component currently has an instance of RenderMeshInterface.
 
bool AssetInUse () const
 Returns if the component is currently using a White Box mesh asset to store its data.
 
void OverrideEditorWhiteBoxMeshAsset (EditorWhiteBoxMeshAsset *editorMeshAsset)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Editor representation of White Box Tool.

Member Function Documentation

◆ OverrideEditorWhiteBoxMeshAsset()

void WhiteBox::EditorWhiteBoxComponent::OverrideEditorWhiteBoxMeshAsset ( EditorWhiteBoxMeshAsset *  editorMeshAsset)

Override the internal EditorWhiteBoxMeshAsset with an external instance.

Note
EditorWhiteBoxComponent takes ownership of the editorMeshAsset and will handle deleting it
The documentation for this class was generated from the following file: