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 | List of all members
AzToolsFramework::Picking::BoundShapeInterface Class Referenceabstract

#include <BoundInterface.h>

Inherited by AzToolsFramework::Picking::ManipulatorBoundBox, AzToolsFramework::Picking::ManipulatorBoundCone, AzToolsFramework::Picking::ManipulatorBoundCylinder, AzToolsFramework::Picking::ManipulatorBoundLineSegment, AzToolsFramework::Picking::ManipulatorBoundQuad, AzToolsFramework::Picking::ManipulatorBoundSphere, AzToolsFramework::Picking::ManipulatorBoundSpline, and AzToolsFramework::Picking::ManipulatorBoundTorus.

Public Member Functions

 AZ_RTTI (BoundShapeInterface, "{C639CB8E-1957-4E4F-B889-3BE1DFBC358D}")
 
 BoundShapeInterface (const RegisteredBoundId boundId)
 
RegisteredBoundId GetBoundId () const
 
virtual bool IntersectRay (const AZ::Vector3 &rayOrigin, const AZ::Vector3 &rayDir, float &rayIntersectionDistance)=0
 
virtual void SetShapeData (const BoundRequestShapeBase &shapeData)=0
 
void SetValidity (bool valid)
 
bool IsValid () const
 

Detailed Description

This class serves as the base class for the actual bound shapes that various DefaultContextBoundManager-derived classes return from the function CreateShape.

Member Function Documentation

◆ IntersectRay()

virtual bool AzToolsFramework::Picking::BoundShapeInterface::IntersectRay ( const AZ::Vector3 &  rayOrigin,
const AZ::Vector3 &  rayDir,
float &  rayIntersectionDistance 
)
pure virtual
Parameters
rayOriginThe origin of the ray to test with.
rayDirThe direction of the ray to test with.
[out]rayIntersectionDistanceThe distance of the intersecting point closest to the ray origin.
Returns
Boolean indicating whether there is a least one intersecting point between this bound shape and the ray.

Implemented in AzToolsFramework::Picking::ManipulatorBoundSphere, AzToolsFramework::Picking::ManipulatorBoundBox, AzToolsFramework::Picking::ManipulatorBoundCylinder, AzToolsFramework::Picking::ManipulatorBoundCone, AzToolsFramework::Picking::ManipulatorBoundQuad, AzToolsFramework::Picking::ManipulatorBoundTorus, AzToolsFramework::Picking::ManipulatorBoundLineSegment, and AzToolsFramework::Picking::ManipulatorBoundSpline.

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