Open CASCADE Technology 6.6.0
Public Member Functions
Visual3d_PickPath Class Reference

PickPath is a vector ( pick_id, struct_id, elem_num ).
It's one of the constituents of a PickDescriptor.
There are many PickPaths in a PickDescriptor.
Each PickPath describes a structure or a sub-structure.
The pick_id is set by SetPickId method from Group.

#include <Visual3d_PickPath.hxx>

Public Member Functions

 Visual3d_PickPath ()
 Creates an undefined PickPath.

 Visual3d_PickPath (const Standard_Integer AElemNumber, const Standard_Integer APickId, const Handle< Graphic3d_Structure > &AStructure)
 Creates a PickPath :
<AElemNumber> : Element number of the structure picked.
<APickId> : Pick identifier of the structure picked.
<AStructure> : The picked structure.

void SetElementNumber (const Standard_Integer AElemNumber)
 Modifies the PickPath <me>.
<AElemNumber> : Element number of the structure picked.

void SetPickIdentifier (const Standard_Integer APickId)
 Modifies the PickPath <me>.
<APickId> : Pick identifier of the structure picked.

void SetStructIdentifier (const Handle< Graphic3d_Structure > &AStructure)
 Modifies the PickPath <me>.
<AStructure> : Identifier of the structure picked.

Standard_Integer ElementNumber () const
 Returns the element number stocked in the PickPath <me>.
Category: Inquire methods
Warning: Raises PickError if PickPath is empty (no picked structure).

Standard_Integer PickIdentifier () const
 Returns the pick identifier stocked in the PickPath <me>.
Category: Inquire methods
Warning: Raises PickError if PickPath is empty (no picked structure).

Handle_Graphic3d_Structure StructIdentifier () const
 Returns the structure stocked in the PickPath <me>.
Category: Inquire methods
Warning: Raises PickError if PickPath is empty (no picked structure).


Constructor & Destructor Documentation

Visual3d_PickPath::Visual3d_PickPath ( )
Visual3d_PickPath::Visual3d_PickPath ( const Standard_Integer  AElemNumber,
const Standard_Integer  APickId,
const Handle< Graphic3d_Structure > &  AStructure 
)

Member Function Documentation

Standard_Integer Visual3d_PickPath::ElementNumber ( ) const
Standard_Integer Visual3d_PickPath::PickIdentifier ( ) const
void Visual3d_PickPath::SetElementNumber ( const Standard_Integer  AElemNumber)
void Visual3d_PickPath::SetPickIdentifier ( const Standard_Integer  APickId)
void Visual3d_PickPath::SetStructIdentifier ( const Handle< Graphic3d_Structure > &  AStructure)
Handle_Graphic3d_Structure Visual3d_PickPath::StructIdentifier ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines