All Frameworks Class Hierarchy This Framework Previous Next Indexes
VisualizationBase Class CAT3DMarkerGP
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VisualizationBase.CATGraphicPrimitive
|
+---CAT3DMarkerGP
Usage: you must use this class as is. You should never derive it.
public class CAT3DMarkerGP
Class to create the graphic primitive of 3D markers.
Role: This graphic primitive is a graphic 3D marker to point to one or
several specific points in the space. A 3D marker size is constant, it does not depend
on the zoom.
Constructor and Destructor Index
- o
CAT3DMarkerGP()
- Default constructor.
- o
CAT3DMarkerGP(float[],int,CATSymbolType,int)
- Constructs 3D markers from a list of 3D points, and the type of symbol wanted to be used.
Method Index
- o
Draw(CATRender&)
- Draws the 3D marker.
- o
Get(float**,int*,CATSymbolType*)
- Retrieves marked points coordinates and the symbol type used
to mark them.
- o
SetSymbolType(CATSymbolType)
- sets the symbol used to mark the points to a new value.
Constructor and Destructor
o CAT3DMarkerGP
-
Default constructor.
o CAT3DMarkerGP
public CAT3DMarkerGP( | const float[] | iPoints, |
| const int | iNbPoints | =1, |
| CATSymbolType | iSymbol | = CROSS, |
| const int | iAlloc | =ALLOCATE) |
-
Constructs 3D markers from a list of 3D points, and the type of symbol wanted to be used.
- Parameters:
-
- iPoints
- Array containing the coordinates of the points to mark : XYZXYZXYZ... Its size is equal
to three times the number of points.
- iNbPoints
- The number of points to mark, which coordinates are stored in the iPoints array.
If no iNbPoints is specified, the number of points is assumed to be 1.
- iSymbol
- The symbol wanted to be used to mark the points.
The default value is CROSS.
- iAlloc
- Flag used to specify whether points must be duplicated or not.
Legal values:
- ALLOCATE
- All data are duplicated into the graphic primitive
- DONT_ALLOCATE
- The graphic primitive has a pointer to the data given as parameter
Warning : If the number of points is equal to 1, the points are duplicated
anyway (Memory issue). The input data must still be destroyed by the caller.
The default value is ALLOCATE.
Methods
o Draw
-
Draws the 3D marker.
- Parameters:
-
- iRender
- The render through which the 3D marker is drawn.
- iViewpoint
- The viewpoint through which the 3D marker is seen.
- iViewport
- The viewport in which the 3D marker is located.
o Get
public inline void Get( | float** | oPoints, |
| int* | oNbPoint, |
| CATSymbolType* | oSymbol) const |
-
Retrieves marked points coordinates and the symbol type used
to mark them.
This method must be called this way:
float * points;
int nbPoints;
SymbolType symbol;
Get(&points, &NbPoints, &symbol);
- Parameters:
-
- oPoints
- Retrieves an array containing marked points coordinates: XYZXYZXYZ...
Its size is equal to three times the number of marked points.
- oNbPoints
- Retrieves the number of points marked by this 3D marker.
- oSymbol
- Retrieves the symbol used to mark the points.
o SetSymbolType
-
sets the symbol used to mark the points to a new value.
- Parameters:
-
- iSymbol
- The new symbol you wish to use.
This object is included in the file: CAT3DMarkerGP.h
If needed, your Imakefile.mk should include the module: CATViz