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.
More...

#include <Visual3d_PickPath.hxx>

Public Member Functions
	Visual3d_PickPath ()
	Creates an undefined PickPath. More...
	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. More...
void	SetElementNumber (const Standard_Integer AElemNumber)
	Modifies the PickPath <me>. <AElemNumber> : Element number of the structure picked. More...
void	SetPickIdentifier (const Standard_Integer APickId)
	Modifies the PickPath <me>. <APickId> : Pick identifier of the structure picked. More...
void	SetStructIdentifier (const Handle< Graphic3d_Structure > &AStructure)
	Modifies the PickPath <me>. <AStructure> : Identifier of the structure picked. More...
Standard_Integer	ElementNumber () const
	Returns the element number stocked in the PickPath <me>. <br> Category: Inquire methods Warning: Raises PickError if PickPath is empty (no picked structure). More...
Standard_Integer	PickIdentifier () const
	Returns the pick identifier stocked in the PickPath <me>. <br> Category: Inquire methods Warning: Raises PickError if PickPath is empty (no picked structure). More...
Handle_Graphic3d_Structure	StructIdentifier () const
	Returns the structure stocked in the PickPath <me>. <br> Category: Inquire methods Warning: Raises PickError if PickPath is empty (no picked structure). More...

Detailed Description

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.

Constructor & Destructor Documentation

Visual3d_PickPath::Visual3d_PickPath

(

)

Creates an undefined PickPath.

Visual3d_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.

Member Function Documentation

Standard_Integer Visual3d_PickPath::ElementNumber

(

)

const

Returns the element number stocked in the PickPath <me>. <br>

Category: Inquire methods
Warning: Raises PickError if PickPath is empty (no picked structure).

Standard_Integer Visual3d_PickPath::PickIdentifier

(

)

const

Returns the pick identifier stocked in the PickPath <me>. <br>

Category: Inquire methods
Warning: Raises PickError if PickPath is empty (no picked structure).

void Visual3d_PickPath::SetElementNumber

(

const Standard_Integer

AElemNumber

)

Modifies the PickPath <me>.
<AElemNumber> : Element number of the structure picked.

void Visual3d_PickPath::SetPickIdentifier

(

const Standard_Integer

APickId

)

Modifies the PickPath <me>.
<APickId> : Pick identifier of the structure picked.

void Visual3d_PickPath::SetStructIdentifier

(

const Handle< Graphic3d_Structure > &

AStructure

)

Modifies the PickPath <me>.
<AStructure> : Identifier of the structure picked.

Handle_Graphic3d_Structure Visual3d_PickPath::StructIdentifier

(

)

const

Returns the structure stocked in the PickPath <me>. <br>

Category: Inquire methods
Warning: Raises PickError if PickPath is empty (no picked structure).

---

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

• Visual3d_PickPath.hxx