Visual3d_PickDescriptor Class Reference

This class contains the pick information.
It contains a certain number of PickPaths.
More...

#include <Visual3d_PickDescriptor.hxx>

Public Member Functions
	Visual3d_PickDescriptor (const Visual3d_ContextPick &CTX)
	Creates a PickDescriptor <me>. More...
void	AddPickPath (const Visual3d_PickPath &APickPath)
	Adds a PickPath to PickDescriptor <me>. More...
void	Clear ()
	Erases all the information in <me>. More...
Standard_Integer	Depth () const
	Returns the pick depth, that is the number of PickPaths available in the PickDescriptor. More...
Handle_Visual3d_HSequenceOfPickPath	PickPath () const
	Returns the group of PickPaths of <me>. More...
Handle_Graphic3d_Structure	TopStructure () const
	Returns the root structure. <br> If the pick order was of the type TOO_TOPFIRST <br> then it's the first structure. <br> If the pick order was of the type TOO_BOTTOMFIRST <br> Then it's the last structure. <br> The pick order is set by the method SetOrder <br> from ContextPick. <br> Category: Inquire methods Warning: Raises PickError if Depth == 0 (no picked structure). More...
Standard_Integer	TopPickId () const
	Returns the root structure pickid. <br> If the pick order was of the type TOO_TOPFIRST <br> then it's the first pickid. <br> If the pick order was of the type TOO_BOTTOMFIRST <br> then it's the last pickid. <br> The pick order is set by the method SetOrder <br> from ContextPick. <br> Category: Inquire methods Warning: Raises PickError if Depth == 0 (no picked structure). More...
Standard_Integer	TopElementNumber () const
	Returns the root structure element number. <br> If the pick order was of the type TOO_TOPFIRST <br> then it's the first element number. <br> If the pick order was of the type TOO_BOTTOMFIRST <br> then it's the last element number. <br> The pick order is set by the method SetOrder <br> from ContextPick. <br> Category: Inquire methods Warning: Raises PickError if Depth == 0 (no picked structure). More...

Detailed Description

This class contains the pick information.
It contains a certain number of PickPaths.

Constructor & Destructor Documentation

Visual3d_PickDescriptor::Visual3d_PickDescriptor

(

const Visual3d_ContextPick &

CTX

)

Creates a PickDescriptor <me>.

Member Function Documentation

void Visual3d_PickDescriptor::AddPickPath

(

const Visual3d_PickPath &

APickPath

)

Adds a PickPath to PickDescriptor <me>.

void Visual3d_PickDescriptor::Clear

(

)

Erases all the information in <me>.

Standard_Integer Visual3d_PickDescriptor::Depth

(

)

const

Returns the pick depth, that is the
number of PickPaths available in the PickDescriptor.

Handle_Visual3d_HSequenceOfPickPath Visual3d_PickDescriptor::PickPath

(

)

const

Returns the group of PickPaths of <me>.

Standard_Integer Visual3d_PickDescriptor::TopElementNumber

(

)

const

Returns the root structure element number. <br>
  If the pick order was of the type TOO_TOPFIRST <br>
  then it's the first element number. <br>
  If the pick order was of the type TOO_BOTTOMFIRST <br>
  then it's the last element number. <br>
  The pick order is set by the method SetOrder <br>
  from ContextPick. <br>

Category: Inquire methods
Warning: Raises PickError if Depth == 0 (no picked structure).

Standard_Integer Visual3d_PickDescriptor::TopPickId

(

)

const

Returns the root structure pickid. <br>
  If the pick order was of the type TOO_TOPFIRST <br>
  then it's the first pickid. <br>
  If the pick order was of the type TOO_BOTTOMFIRST <br>
  then it's the last pickid. <br>
  The pick order is set by the method SetOrder <br>
  from ContextPick. <br>

Category: Inquire methods
Warning: Raises PickError if Depth == 0 (no picked structure).

Handle_Graphic3d_Structure Visual3d_PickDescriptor::TopStructure

(

)

const

Returns the root structure. <br>
  If the pick order was of the type TOO_TOPFIRST <br>
  then it's the first structure. <br>
  If the pick order was of the type TOO_BOTTOMFIRST <br>
  Then it's the last structure. <br>
  The pick order is set by the method SetOrder <br>
  from ContextPick. <br>

Category: Inquire methods
Warning: Raises PickError if Depth == 0 (no picked structure).

---

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

• Visual3d_PickDescriptor.hxx