Open 3D Engine LmbrCentral 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 | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
LmbrCentral::EditorBaseShapeComponent Class Reference

Common functionality for Editor Component Shapes. More...

#include <EditorBaseShapeComponent.h>

Inherits AzToolsFramework::Components::EditorComponentBase, EditorShapeComponentRequestsBus::Handler, AzToolsFramework::EditorComponentSelectionRequestsBus::Handler, AzToolsFramework::EditorComponentSelectionNotificationsBus::Handler, AZ::TransformNotificationBus::Handler, AzFramework::BoundsRequestBus::Handler, and ShapeComponentNotificationsBus::Handler.

Inherited by LmbrCentral::EditorAxisAlignedBoxShapeComponent, LmbrCentral::EditorBoxShapeComponent, LmbrCentral::EditorCapsuleShapeComponent, LmbrCentral::EditorCompoundShapeComponent, LmbrCentral::EditorCylinderShapeComponent, LmbrCentral::EditorDiskShapeComponent, LmbrCentral::EditorPolygonPrismShapeComponent, LmbrCentral::EditorQuadShapeComponent, LmbrCentral::EditorSphereShapeComponent, and LmbrCentral::EditorTubeShapeComponent.

Public Member Functions

 AZ_RTTI (EditorBaseShapeComponent, "{32B9D7E9-6743-427B-BAFD-1C42CFBE4879}", AzToolsFramework::Components::EditorComponentBase)
 
void Activate () override
 
void Deactivate () override
 
void OnTransformChanged (const AZ::Transform &, const AZ::Transform &) override
 
void SetShapeColor (const AZ::Color &solidColor) override
 
void SetShapeWireframeColor (const AZ::Color &wireColor) override
 
void SetVisibleInEditor (bool visible) override
 
void SetVisibleInGame (bool visible) override
 
void SetShapeColorIsEditable (bool editable) override
 
bool GetShapeColorIsEditable () override
 
AZ::Aabb GetWorldBounds () const override
 
AZ::Aabb GetLocalBounds () const override
 
void OnShapeChanged (ShapeChangeReasons changeReason) override
 
bool CanDraw () const
 Should shape be rendered all the time, even when not selected.
 
void SetShapeComponentConfig (ShapeComponentConfig *shapeConfig)
 

Static Public Member Functions

static void Reflect (AZ::SerializeContext &context)
 

Protected Member Functions

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
 
bool SupportsEditorRayIntersectViewport (const AzFramework::ViewportInfo &viewportInfo) override
 
void OnAccentTypeChanged (AzToolsFramework::EntityAccentType accent) override
 

Static Protected Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 

Protected Attributes

AZ::Color m_shapeColor = AzFramework::ViewportColors::DeselectedColor
 
AZ::Color m_shapeWireColor = AzFramework::ViewportColors::WireColor
 
AZ::Color m_shapeColorSaved = AzFramework::ViewportColors::DeselectedColor
 
bool m_shapeColorIsEditable = true
 
bool m_visibleInEditor = true
 
bool m_visibleInGameView = false
 
bool m_displayFilled = true
 
ShapeComponentConfig * m_shapeConfig = nullptr
 

Detailed Description

Common functionality for Editor Component Shapes.

The documentation for this class was generated from the following file: