All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

AnalysisMeshingModel Class CATMSHSelectionTrap

CATMSHSelectionTrap
 

Usage: you must use this class as is. You should never derive it.


public class CATMSHSelectionTrap

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 CATIMSHTrapSelector 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 CATMSHSelectionTrap ), or implicitely managed by a dialog agent.


Constructor and Destructor Index


o CATMSHSelectionTrap(CATMSHTrapMode,CATMathPlane*,int,CATMathPoint2D*)
Constructs a selection trap from contour definition.
o ~CATMSHSelectionTrap()
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 GetPlane()
Returns the plane on which the trap is defined.
o GetPoints(CATMathPoint2D*&)
Get the definition of the trap contour.

Constructor and Destructor


o CATMSHSelectionTrap
public CATMSHSelectionTrap(CATMSHTrapMode iMode,
CATMathPlane* iPlane,
int iNbPoints,
CATMathPoint2D* 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 ~CATMSHSelectionTrap
public virtual ~CATMSHSelectionTrap()
Destructor.

Methods


o Contains
public int Contains( const double[3] 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
public inline CATMSHTrapMode GetMode()
Returns the selection mode of the trap.
o GetPlane
public const CATMathPlane * GetPlane()
Returns the plane on which the trap is defined.
o GetPoints
public int GetPoints( const CATMathPoint2D*& oPoints)
Get the definition of the trap contour.
Parameters:
oPoints
Array containing points defining the trap contour.
The contour is implicitely closed.
Returns:
The number of points definig the contour.

This object is included in the file: CATMSHSelectionTrap.h
If needed, your Imakefile.mk should include the module: CATAmtModel

Copyright © 2003, Dassault Systèmes. All rights reserved.