castor3d::Picking Class Reference

#include <Picking.hpp>

Inheritance diagram for castor3d::Picking:

Collaboration diagram for castor3d::Picking:

Public Member Functions
C3D_API	Picking (crg::ResourcesCache const &resources, RenderDevice const &device, QueueData const &queueData, castor::Size const &size, CameraUbo const &cameraUbo, SceneUbo const &sceneUbo, SceneCuller &culler)
	Constructor.
C3D_API	~Picking () noexcept
	Destructor.
C3D_API PickNodeType	pick (castor::Position position)
	Picks a geometry at given mouse position.
Geometry const *	getPickedGeometry () const noexcept
BillboardBase const *	getPickedBillboard () const noexcept
Submesh const *	getPickedSubmesh () const noexcept
uint32_t	getPickedFace () const noexcept
PickNodeType	getPickedNodeType () const noexcept
crg::ImageViewId const &	getImageView () const noexcept
crg::SemaphoreWaitArray const &	getSemaphoreWait () const noexcept
bool	isPicking () const noexcept
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructor.

Constructor & Destructor Documentation

Picking()

C3D_API castor3d::Picking::Picking	(	crg::ResourcesCache const &	resources,
		RenderDevice const &	device,
		QueueData const &	queueData,
		castor::Size const &	size,
		CameraUbo const &	cameraUbo,
		SceneUbo const &	sceneUbo,
		SceneCuller &	culler )

Constructor.

Parameters

[in]	resources	The graph resources handler.
[in]	device	The GPU device.
[in]	queueData	The queue receiving the GPU commands.
[in]	size	The render area dimensions.
[in]	cameraUbo	The scene matrices UBO.
[in]	sceneUbo	The scene UBO.
[in]	culler	The culler for this pass.

~Picking()

C3D_API castor3d::Picking::~Picking ( )

noexcept

Destructor.

Member Function Documentation

getImageView()

crg::ImageViewId const & castor3d::Picking::getImageView ( ) const

inlinenoexcept

getPickedBillboard()

BillboardBase const * castor3d::Picking::getPickedBillboard ( ) const

inlinenoexcept

getPickedFace()

uint32_t castor3d::Picking::getPickedFace ( ) const

inlinenoexcept

getPickedGeometry()

Geometry const * castor3d::Picking::getPickedGeometry ( ) const

inlinenoexcept

name Getters.

getPickedNodeType()

PickNodeType castor3d::Picking::getPickedNodeType ( ) const

inlinenoexcept

getPickedSubmesh()

Submesh const * castor3d::Picking::getPickedSubmesh ( ) const

inlinenoexcept

getSemaphoreWait()

crg::SemaphoreWaitArray const & castor3d::Picking::getSemaphoreWait ( ) const

inlinenoexcept

isPicking()

bool castor3d::Picking::isPicking ( ) const

inlinenoexcept

pick()

C3D_API PickNodeType castor3d::Picking::pick

(

castor::Position

position

)

Picks a geometry at given mouse position.

Parameters

[in]

position

The position in the pass.

Returns

PickingPass::PickNodeType::eNone if nothing was picked.

---

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

• Castor3D/Render/Picking.hpp