Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
Visual3d_PickDescriptor Class Reference

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

#include <Visual3d_PickDescriptor.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC Visual3d_PickDescriptor (const Visual3d_ContextPick &CTX)
 Creates a PickDescriptor <me>.

void AddPickPath (const Visual3d_PickPath &APickPath)
 Adds a PickPath to PickDescriptor <me>.

void Clear ()
 Erases all the information in <me>.

Standard_Integer Depth () const
 Returns the pick depth, that is the
number of PickPaths available in the PickDescriptor.

Handle_Visual3d_HSequenceOfPickPath PickPath () const
 Returns the group of PickPaths of <me>.

Handle_Graphic3d_Structure TopStructure () const
 Returns the root structure.
If the pick order was of the type TOO_TOPFIRST
then it's the first structure.
If the pick order was of the type TOO_BOTTOMFIRST
Then it's the last structure.
The pick order is set by the method SetOrder
from ContextPick.
Category: Inquire methods
Warning: Raises PickError if Depth == 0 (no picked structure).

Standard_Integer TopPickId () const
 Returns the root structure pickid.
If the pick order was of the type TOO_TOPFIRST
then it's the first pickid.
If the pick order was of the type TOO_BOTTOMFIRST
then it's the last pickid.
The pick order is set by the method SetOrder
from ContextPick.
Category: Inquire methods
Warning: Raises PickError if Depth == 0 (no picked structure).

Standard_Integer TopElementNumber () const
 Returns the root structure element number.
If the pick order was of the type TOO_TOPFIRST
then it's the first element number.
If the pick order was of the type TOO_BOTTOMFIRST
then it's the last element number.
The pick order is set by the method SetOrder
from ContextPick.
Category: Inquire methods
Warning: Raises PickError if Depth == 0 (no picked structure).


Constructor & Destructor Documentation


Member Function Documentation

Handle_Visual3d_HSequenceOfPickPath Visual3d_PickDescriptor::PickPath ( ) const
Handle_Graphic3d_Structure Visual3d_PickDescriptor::TopStructure ( ) const

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