PLEngine::Picking Class Reference

Class offering scene picking (some also call it 'trace line') functionality. More...

#include <Picking.h>

Inheritance diagram for PLEngine::Picking:

List of all members.

Public Member Functions
PL_API	Picking ()
	Constructor.
virtual PL_API	~Picking ()
	Destructor.
PL_API bool	PerformPicking (PickingResult &cPickingResult, PLScene::SceneContainer &cContainer, const PLMath::Vector3 &vLineStartPos, const PLMath::Vector3 &vLineEndPos, PLRenderer::Cull::Enum nCull=PLRenderer::Cull::CCW)
	Performs picking by using the given line start and end positions.
PL_API bool	PerformPicking (PickingResult &cPickingResult, PLScene::SceneNode &cSceneNode, const PLMath::Vector3 &vLineStartPos, const PLMath::Vector3 &vLineEndPos, PLCore::Array< PLCore::uint32 > *plstGeometries=nullptr, PLRenderer::Cull::Enum nCull=PLRenderer::Cull::CCW)
	Performs picking using the mesh of the given scene node by using the given line start and end positions.
Protected Member Functions
virtual PL_API bool	OnPickingCandidate (PLScene::SceneNode &cSceneNode)
	Function that is called when a picking candidate has been found ("picking filter function")

---

Detailed Description

Class offering scene picking (some also call it 'trace line') functionality.

---

Constructor & Destructor Documentation

PL_API PLEngine::Picking::Picking

(

)

Constructor.

virtual PL_API PLEngine::Picking::~Picking

(

)

[virtual]

Destructor.

---

Member Function Documentation

PL_API bool PLEngine::Picking::PerformPicking	(	PickingResult &	cPickingResult,
		PLScene::SceneContainer &	cContainer,
		const PLMath::Vector3 &	vLineStartPos,
		const PLMath::Vector3 &	vLineEndPos,
		PLRenderer::Cull::Enum	nCull = PLRenderer::Cull::CCW
	)

Performs picking by using the given line start and end positions.

Parameters:

[out]	cPickingResult	Receives the picking result if all went fine
[in]	cContainer	Scene container we're performing the picking in
[in]	vLineStartPos	Picking line start position within the given scene container
[in]	vLineEndPos	Picking line end position within the given scene container
[in]	nCull	Cull mode (see "PLRenderer::Cull")

Returns:

'true' if anything has been picked, else 'false'

PL_API bool PLEngine::Picking::PerformPicking	(	PickingResult &	cPickingResult,
		PLScene::SceneNode &	cSceneNode,
		const PLMath::Vector3 &	vLineStartPos,
		const PLMath::Vector3 &	vLineEndPos,
		PLCore::Array< PLCore::uint32 > *	plstGeometries = nullptr,
		PLRenderer::Cull::Enum	nCull = PLRenderer::Cull::CCW
	)

Performs picking using the mesh of the given scene node by using the given line start and end positions.

Parameters:

[out]	cPickingResult	Receives the picking result if all went fine
[in]	cSceneNode	Scene node we're performing the mesh picking in
[in]	vLineStartPos	Picking line start position within the given scene node
[in]	vLineEndPos	Picking line end position within the given scene node
[in]	plstGeometries	List of mesh geometry indices to use, if a null pointer all mesh geometries are used
[in]	nCull	Cull mode (see "PLRenderer::Cull")

Returns:

'true' if anything has been picked, else 'false'

virtual PL_API bool PLEngine::Picking::OnPickingCandidate

(

PLScene::SceneNode &

cSceneNode

)

[protected, virtual]

Function that is called when a picking candidate has been found ("picking filter function")

Parameters:

[in]

cSceneNode

Scene node candidate

Returns:

'true' to take this candidate into account, else 'false' to throw it away (no further processing of the scene node)

Note:

• The default implementation is empty

---

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

• Picking.h