WhiteBox::EditorWhiteBoxDefaultModeRequests Class Reference

Request bus for White Box ComponentMode operations while in 'default' mode. More...

#include <EditorWhiteBoxDefaultModeBus.h>

Inherits AZ::EntityComponentBus.

Public Member Functions
virtual void	CreatePolygonScaleModifier (const Api::PolygonHandle &polygonHandle)=0
	Create a polygon scale modifier for the given polygon handles.
virtual void	CreateEdgeScaleModifier (Api::EdgeHandle edgeHandle)=0
	Create an edge scale modifier for the given edge handle.
virtual void	AssignSelectedPolygonTranslationModifier ()=0
	Assign whatever polygon is currently hovered to the selected polygon translation modifier.
virtual void	AssignSelectedEdgeTranslationModifier ()=0
	Assign whatever edge is currently hovered to the selected edge translation modifier.
virtual void	AssignSelectedVertexSelectionModifier ()=0
	Assign whatever vertex is currently hovered to the vertex selection modifier.
virtual void	RefreshPolygonScaleModifier ()=0
virtual void	RefreshEdgeScaleModifier ()=0
virtual void	RefreshPolygonTranslationModifier ()=0
virtual void	RefreshEdgeTranslationModifier ()=0
virtual void	RefreshVertexSelectionModifier ()=0
virtual Api::VertexHandles	SelectedVertexHandles () const =0
virtual Api::EdgeHandles	SelectedEdgeHandles () const =0
virtual Api::PolygonHandles	SelectedPolygonHandles () const =0
virtual Api::VertexHandle	HoveredVertexHandle () const =0
virtual Api::EdgeHandle	HoveredEdgeHandle () const =0
virtual Api::PolygonHandle	HoveredPolygonHandle () const =0
virtual void	HideSelectedEdge ()=0
	Hide the selected Edge.
virtual void	HideSelectedVertex ()=0
	Hide the selected Vertex.

Detailed Description

Request bus for White Box ComponentMode operations while in 'default' mode.

Member Function Documentation

HoveredEdgeHandle()

virtual Api::EdgeHandle WhiteBox::EditorWhiteBoxDefaultModeRequests::HoveredEdgeHandle ( ) const

pure virtual

Returns the hovered edge handle.

Note

If no edge is currently being hovered then an invalid EdgeHandle is returned.

HoveredPolygonHandle()

virtual Api::PolygonHandle WhiteBox::EditorWhiteBoxDefaultModeRequests::HoveredPolygonHandle ( ) const

pure virtual

Returns the hovered polygon handle.

Note

If no polygon is currently being hovered then an empty PolygonHandle is returned.

HoveredVertexHandle()

virtual Api::VertexHandle WhiteBox::EditorWhiteBoxDefaultModeRequests::HoveredVertexHandle ( ) const

pure virtual

Returns the hovered vertex handle.

Note

If no vertex is currently being hovered then an invalid VertexHandle is returned.

RefreshEdgeScaleModifier()

virtual void WhiteBox::EditorWhiteBoxDefaultModeRequests::RefreshEdgeScaleModifier ( )

pure virtual

Refresh (rebuild) the edge scale modifier. The internal manipulator will be rebuilt from the current white box handles stored in the modifier.

RefreshEdgeTranslationModifier()

virtual void WhiteBox::EditorWhiteBoxDefaultModeRequests::RefreshEdgeTranslationModifier ( )

pure virtual

Refresh (rebuild) the edge translation modifier. The internal manipulator will be rebuilt from the current white box handles stored in the modifier.

RefreshPolygonScaleModifier()

virtual void WhiteBox::EditorWhiteBoxDefaultModeRequests::RefreshPolygonScaleModifier ( )

pure virtual

Refresh (rebuild) the polygon scale modifier. The internal manipulator will be rebuilt from the current white box handles stored in the modifier.

RefreshPolygonTranslationModifier()

virtual void WhiteBox::EditorWhiteBoxDefaultModeRequests::RefreshPolygonTranslationModifier ( )

pure virtual

Refresh (rebuild) the polygon translation modifier. The internal manipulator will be rebuilt from the current white box handles stored in the modifier.

RefreshVertexSelectionModifier()

virtual void WhiteBox::EditorWhiteBoxDefaultModeRequests::RefreshVertexSelectionModifier ( )

pure virtual

Refresh (rebuild) the vertex selection modifier. The internal manipulator will be rebuilt from the current white box handles stored in the modifier.

SelectedEdgeHandles()

virtual Api::EdgeHandles WhiteBox::EditorWhiteBoxDefaultModeRequests::SelectedEdgeHandles ( ) const

pure virtual

Returns the currently selected edge handles.

Note

If no edge handles are selected an empty vector is returned.

SelectedPolygonHandles()

virtual Api::PolygonHandles WhiteBox::EditorWhiteBoxDefaultModeRequests::SelectedPolygonHandles ( ) const

pure virtual

Returns the currently selected polygon handles.

Note

If no polygon handles are selected an empty vector is returned.

SelectedVertexHandles()

virtual Api::VertexHandles WhiteBox::EditorWhiteBoxDefaultModeRequests::SelectedVertexHandles ( ) const

pure virtual

Returns the currently selected vertex handles.

Note

If no vertex handles are selected an empty vector is returned.

---

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

• Gems/WhiteBox/Code/Source/SubComponentModes/EditorWhiteBoxDefaultModeBus.h