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 Types | Public Member Functions | Public Attributes | List of all members
AzToolsFramework::ManipulatorViewCircle Class Reference

#include <ManipulatorView.h>

Inherits AzToolsFramework::ManipulatorView.

Public Types

using DrawCircleFunc = void(*)(AzFramework::DebugDisplayRequests &, const AZ::Vector3 &, float, const AZ::Vector3 &)
 

Public Member Functions

void Draw (ManipulatorManagerId managerId, const ManipulatorManagerState &managerState, ManipulatorId manipulatorId, const ManipulatorState &manipulatorState, AzFramework::DebugDisplayRequests &debugDisplay, const AzFramework::CameraState &cameraState, const ViewportInteraction::MouseInteraction &mouseInteraction) override
 
- Public Member Functions inherited from AzToolsFramework::ManipulatorView
 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
 

Public Attributes

AZ::Vector3 m_axis
 
float m_width = 0.0f
 
float m_radius = 0.0f
 
AZ::Color m_color = AZ::Colors::Red
 
DrawCircleFunc m_drawCircleFunc = nullptr
 

Additional Inherited Members

- Protected Member Functions inherited from AzToolsFramework::ManipulatorView
float ManipulatorViewScaleMultiplier (const AZ::Vector3 &worldPosition, const AzFramework::CameraState &cameraState) const
 
- Protected Attributes inherited from AzToolsFramework::ManipulatorView
AZ::Color m_mouseOverColor = BaseManipulator::s_defaultMouseOverColor
 

Detailed Description

Displays a wire circle. DrawCircleFunc can be used to either draw a full circle or a half dotted circle where the part of the circle facing away from the camera is dotted (useful for angular/rotation manipulators).

Member Function Documentation

◆ Draw()

void AzToolsFramework::ManipulatorViewCircle::Draw ( ManipulatorManagerId  managerId,
const ManipulatorManagerState &  managerState,
ManipulatorId  manipulatorId,
const ManipulatorState &  manipulatorState,
AzFramework::DebugDisplayRequests &  debugDisplay,
const AzFramework::CameraState &  cameraState,
const ViewportInteraction::MouseInteraction &  mouseInteraction 
)
overridevirtual

Implements AzToolsFramework::ManipulatorView.

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