Open 3D Engine AzToolsFramework 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 | Protected Member Functions | Protected Attributes | List of all members
AzToolsFramework::ManipulatorView Class Referenceabstract

#include <ManipulatorView.h>

Inherited by AzToolsFramework::ManipulatorViewBox, AzToolsFramework::ManipulatorViewCircle, AzToolsFramework::ManipulatorViewCone, AzToolsFramework::ManipulatorViewCylinder, AzToolsFramework::ManipulatorViewLine, AzToolsFramework::ManipulatorViewLineSelect, AzToolsFramework::ManipulatorViewProjectedCircle, AzToolsFramework::ManipulatorViewQuad, AzToolsFramework::ManipulatorViewQuadBillboard, AzToolsFramework::ManipulatorViewSphere, and AzToolsFramework::ManipulatorViewSplineSelect.

Public Member Functions

 ManipulatorView (bool screenSizeFixed)
 
 ManipulatorView (ManipulatorView &&)=default
 
ManipulatorView & operator= (ManipulatorView &&)=default
 
void SetBoundDirty (ManipulatorManagerId managerId)
 
void RefreshBound (ManipulatorManagerId managerId, ManipulatorId manipulatorId, const Picking::BoundRequestShapeBase &bound)
 
void Invalidate (ManipulatorManagerId managerId)
 
virtual void Draw (ManipulatorManagerId managerId, const ManipulatorManagerState &managerState, ManipulatorId manipulatorId, const ManipulatorState &manipulatorState, AzFramework::DebugDisplayRequests &debugDisplay, const AzFramework::CameraState &cameraState, const ViewportInteraction::MouseInteraction &mouseInteraction)=0
 
bool ScreenSizeFixed () const
 

Protected Member Functions

float ManipulatorViewScaleMultiplier (const AZ::Vector3 &worldPosition, const AzFramework::CameraState &cameraState) const
 

Protected Attributes

AZ::Color m_mouseOverColor = BaseManipulator::s_defaultMouseOverColor
 

Detailed Description

The base interface for the visual representation of manipulators. The View represents the appearance and bounds of the manipulator for the user to interact with. Any manipulator can have any view (some may be more appropriate than others in certain cases).

Member Function Documentation

◆ ManipulatorViewScaleMultiplier()

float AzToolsFramework::ManipulatorView::ManipulatorViewScaleMultiplier ( const AZ::Vector3 &  worldPosition,
const AzFramework::CameraState &  cameraState 
) const
protected

Scale the manipulator based on the distance from the camera if m_screenSizeFixed is true.

Member Data Documentation

◆ m_mouseOverColor

AZ::Color AzToolsFramework::ManipulatorView::m_mouseOverColor = BaseManipulator::s_defaultMouseOverColor
protected

What color should the manipulator be when the mouse is hovering over it.

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