Visual3d_ContextPick Class Reference

This class allows the creation and update of a pick context for one view of the viewer. A context allows the control of different parameters before the activation of a pick. More...

#include <Visual3d_ContextPick.hxx>

Public Member Functions
	Visual3d_ContextPick ()
	Creates a context from default values. More...
	Visual3d_ContextPick (const Standard_Real Aperture, const Standard_Integer Depth, const Visual3d_TypeOfOrder Order)
	Creates a context with the values defined Warning: Raises ContextPickDefinitionError if <Depth> or <Aperture> is a negative value. More...
void	SetAperture (const Standard_Real Aperture)
	Modifies the size of the pick window. Category: Methods to modifies the class definition Warning: Raises ContextPickDefinitionError if <Aperture> is a negative value. More...
void	SetDepth (const Standard_Integer Depth)
	Modifies the pick depth a priori. Category: Methods to modifies the class definition Warning: Raises ContextPickDefinitionError if <Depth> is a negative value. More...
void	SetOrder (const Visual3d_TypeOfOrder Order)
	Modifies the order of picking. More...
Standard_Real	Aperture () const
	Returns the size of the pick window <me>. More...
Standard_Integer	Depth () const
	Returns the effective pick depth of <me>. More...
Visual3d_TypeOfOrder	Order () const
	Returns the order of picking of <me>. More...

Detailed Description

This class allows the creation and update of a pick context for one view of the viewer. A context allows the control of different parameters before the activation of a pick.

• the pick aperture.
• the depth of pick, the number of sub-structures selected.
• the order of picking, the possibility to traverse the pick structures starting from the root or the leaves.

Constructor & Destructor Documentation

Visual3d_ContextPick::Visual3d_ContextPick

(

)

Creates a context from default values.

Aperture : 4.0 Depth : 10 Order : TOO_TOPFIRST

Visual3d_ContextPick::Visual3d_ContextPick	(	const Standard_Real	Aperture,
		const Standard_Integer	Depth,
		const Visual3d_TypeOfOrder	Order
	)

Creates a context with the values defined Warning: Raises ContextPickDefinitionError if <Depth> or <Aperture> is a negative value.

Member Function Documentation

Standard_Real Visual3d_ContextPick::Aperture

(

)

const

Returns the size of the pick window <me>.

Standard_Integer Visual3d_ContextPick::Depth

(

)

const

Returns the effective pick depth of <me>.

Visual3d_TypeOfOrder Visual3d_ContextPick::Order

(

)

const

Returns the order of picking of <me>.

TypeOfOrder : TOO_TOPFIRST TOO_BOTTOMFIRST

void Visual3d_ContextPick::SetAperture

(

const Standard_Real

Aperture

)

Modifies the size of the pick window. Category: Methods to modifies the class definition Warning: Raises ContextPickDefinitionError if <Aperture> is a negative value.

void Visual3d_ContextPick::SetDepth

(

const Standard_Integer

Depth

)

Modifies the pick depth a priori. Category: Methods to modifies the class definition Warning: Raises ContextPickDefinitionError if <Depth> is a negative value.

void Visual3d_ContextPick::SetOrder

(

const Visual3d_TypeOfOrder

Order

)

Modifies the order of picking.

TypeOfOrder : TOO_TOPFIRST TOO_BOTTOMFIRST

---

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

• Visual3d_ContextPick.hxx