SelectBasics_PickResult Struct Reference

This structure provides unified access to the results of Matches() method in all sensitive entities, so that it defines a Depth (distance to the entity along picking ray) and a closest Point on entity. More...

#include <SelectBasics_PickResult.hxx>

Public Member Functions
	SelectBasics_PickResult ()
	Empty constructor defining an invalid result.
	SelectBasics_PickResult (Standard_Real theDepth, Standard_Real theDistToCenter, const gp_Pnt &theObjPickedPnt)
	Constructor with initialization.
Standard_Boolean	IsValid () const
	Return TRUE if result was been defined.
void	Invalidate ()
	Reset depth value.
Standard_Real	Depth () const
	Return depth along picking ray.
void	SetDepth (Standard_Real theDepth)
	Set depth along picking ray.
Standard_Boolean	HasPickedPoint () const
	Return TRUE if Picked Point lying on detected entity was set.
const gp_Pnt &	PickedPoint () const
	Return picked point lying on detected entity. WARNING! Point is defined in local coordinate system and should be translated into World System before usage!
void	SetPickedPoint (const gp_Pnt &theObjPickedPnt)
	Set picked point.
Standard_Real	DistToGeomCenter () const
	Return distance to geometry center (auxiliary value for comparing results).
void	SetDistToGeomCenter (Standard_Real theDistToCenter)
	Set distance to geometry center.
const NCollection_Vec3< float > &	SurfaceNormal () const
	Return (unnormalized) surface normal at picked point or zero vector if undefined. WARNING! Normal is defined in local coordinate system and should be translated into World System before usage!
void	SetSurfaceNormal (const NCollection_Vec3< float > &theNormal)
	Set surface normal at picked point.
void	SetSurfaceNormal (const gp_Vec &theNormal)
	Set surface normal at picked point.

Static Public Member Functions
static const SelectBasics_PickResult &	Min (const SelectBasics_PickResult &thePickResult1, const SelectBasics_PickResult &thePickResult2)
	Return closest result between two Pick Results according to Depth value.

Detailed Description

This structure provides unified access to the results of Matches() method in all sensitive entities, so that it defines a Depth (distance to the entity along picking ray) and a closest Point on entity.

Constructor & Destructor Documentation

SelectBasics_PickResult() [1/2]

SelectBasics_PickResult::SelectBasics_PickResult ( )

inline

Empty constructor defining an invalid result.

SelectBasics_PickResult() [2/2]

SelectBasics_PickResult::SelectBasics_PickResult ( Standard_Real  theDepth, Standard_Real  theDistToCenter, const gp_Pnt &  theObjPickedPnt  )

inline

Constructor with initialization.

Member Function Documentation

Depth()

Standard_Real SelectBasics_PickResult::Depth ( ) const

inline

Return depth along picking ray.

DistToGeomCenter()

Standard_Real SelectBasics_PickResult::DistToGeomCenter ( ) const

inline

Return distance to geometry center (auxiliary value for comparing results).

HasPickedPoint()

Standard_Boolean SelectBasics_PickResult::HasPickedPoint ( ) const

inline

Return TRUE if Picked Point lying on detected entity was set.

Invalidate()

void SelectBasics_PickResult::Invalidate ( )

inline

Reset depth value.

IsValid()

Standard_Boolean SelectBasics_PickResult::IsValid ( ) const

inline

Return TRUE if result was been defined.

Min()

static const SelectBasics_PickResult & SelectBasics_PickResult::Min ( const SelectBasics_PickResult &  thePickResult1, const SelectBasics_PickResult &  thePickResult2  )

inlinestatic

Return closest result between two Pick Results according to Depth value.

PickedPoint()

const gp_Pnt & SelectBasics_PickResult::PickedPoint ( ) const

inline

Return picked point lying on detected entity. WARNING! Point is defined in local coordinate system and should be translated into World System before usage!

SetDepth()

void SelectBasics_PickResult::SetDepth ( Standard_Real  theDepth )

inline

Set depth along picking ray.

SetDistToGeomCenter()

void SelectBasics_PickResult::SetDistToGeomCenter ( Standard_Real  theDistToCenter )

inline

Set distance to geometry center.

SetPickedPoint()

void SelectBasics_PickResult::SetPickedPoint ( const gp_Pnt &  theObjPickedPnt )

inline

Set picked point.

SetSurfaceNormal() [1/2]

void SelectBasics_PickResult::SetSurfaceNormal ( const gp_Vec &  theNormal )

inline

Set surface normal at picked point.

SetSurfaceNormal() [2/2]

void SelectBasics_PickResult::SetSurfaceNormal ( const NCollection_Vec3< float > &  theNormal )

inline

Set surface normal at picked point.

SurfaceNormal()

const NCollection_Vec3< float > & SelectBasics_PickResult::SurfaceNormal ( ) const

inline

Return (unnormalized) surface normal at picked point or zero vector if undefined. WARNING! Normal is defined in local coordinate system and should be translated into World System before usage!

---

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

• SelectBasics_PickResult.hxx