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

Services provided by the Editor Shape Component. More...

#include <EditorShapeComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void SetShapeColor (const AZ::Color &solidColor)=0
 Sets the shape color.
 
virtual void SetShapeWireframeColor (const AZ::Color &wireColor)=0
 Sets the wireframe shape color.
 
virtual void SetVisibleInEditor (bool visible)=0
 Sets if the shape should be visible in the editor when the object is deselected.
 
virtual void SetShapeColorIsEditable (bool editable)=0
 Sets if the shape color can be set by the user in the editor. This is useful for components that need to control the shape's color directly.
 
virtual bool GetShapeColorIsEditable ()=0
 Returns true if the shape color can be set by the user in the editor.
 
virtual void SetVisibleInGame (bool visible)=0
 Sets if the shape is visible in game view.
 

Detailed Description

Services provided by the Editor Shape Component.

Member Function Documentation

◆ SetShapeColor()

virtual void LmbrCentral::EditorShapeComponentRequests::SetShapeColor ( const AZ::Color &  solidColor)
pure virtual

Sets the shape color.

Parameters
solidColorthe color to be used for drawing solid shapes

◆ SetShapeColorIsEditable()

virtual void LmbrCentral::EditorShapeComponentRequests::SetShapeColorIsEditable ( bool  editable)
pure virtual

Sets if the shape color can be set by the user in the editor. This is useful for components that need to control the shape's color directly.

Parameters
editabletrue if the shape color should be editable

◆ SetShapeWireframeColor()

virtual void LmbrCentral::EditorShapeComponentRequests::SetShapeWireframeColor ( const AZ::Color &  wireColor)
pure virtual

Sets the wireframe shape color.

Parameters
wireColorthe color to be used for drawing shapes in wireframe

◆ SetVisibleInEditor()

virtual void LmbrCentral::EditorShapeComponentRequests::SetVisibleInEditor ( bool  visible)
pure virtual

Sets if the shape should be visible in the editor when the object is deselected.

Parameters
visibletrue if the shape should be visible when deselected

◆ SetVisibleInGame()

virtual void LmbrCentral::EditorShapeComponentRequests::SetVisibleInGame ( bool  visible)
pure virtual

Sets if the shape is visible in game view.

Parameters
visibletrue for shape to be visible
The documentation for this class was generated from the following file: