CATFmtToolsInterfaces CATFmtSelectionTrap
Usage: you must use this class as is. You should never derive it.
public class CATFmtSelectionTrap
Object representing a selection trap.
Role: A selection trap is a closed polygonal planar contour which may be used to select objects at screen.
The selection trap is used by the interface to build the list of selected objects from the contour.
The selection trap can be be either explicitely built from a contour definition ( see
), or implicitely managed by a dialog agent.
Constructor and Destructor Index
- o
CATFmtSelectionTrap(CATFmtTrapMode,CATMathPlane*,int,CATMathPoint2D*)
- Constructs a selection trap from contour definition.
- o
~CATFmtSelectionTrap()
- Destructor.
Method Index
- o
Contains(double[3])
- Query if a given location is included within the trap.
- o
GetMode()
- Returns the selection mode of the trap.
- o
GetNbOfPoints()
- Returns number of points defining the contour.
- o
GetPlane()
- Returns the plane on which the trap is defined.
- o
GetPoints()
- Returns the points defining the contour.
Constructor and Destructor
o CATFmtSelectionTrap
| public CATFmtSelectionTrap( | | iMode, |
| | iPlane, |
| | iNbPoints, |
| | iPoints) |
-
Constructs a selection trap from contour definition.
- Parameters:
-
- iMode
- Selection mode for trap (intersecting or inclusive).
- iPlane
- Plane on which the selection trap is defined.
- iNbPoints
- Number of points defining the trap contour.
- iPoints
- Array of points defining the trap contour. This array should contain iNbPoints points.
The contour is implicitely closed.
o ~CATFmtSelectionTrap
| public virtual ~CATFmtSelectionTrap( | ) |
-
Destructor.
Methods
o Contains
| public Contains( | const | iXYZ) |
-
Query if a given location is included within the trap.
- Parameters:
-
- iXYZ
- Coordinates of the location.
- Returns:
- The result of the query.
Legal values:
- 0
- The location is outside the trap contour.
- 1
- The location is inside the trap contour.
o GetMode
-
Returns the selection mode of the trap.
o GetNbOfPoints
-
Returns number of points defining the contour.
o GetPlane
-
Returns the plane on which the trap is defined.
o GetPoints
-
Returns the points defining the contour.
This object is included in the file: CATFmtSelectionTrap.h
If needed, your Imakefile.mk should include the module: CATFmtToolsInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.