VisualizationFoundation 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.
o ~CAT3DMarkerGP()

Method Index


o Draw(CATRender&)
Draws the 3D marker.
o Get(float**,int*,CATSymbolType*)
o GetReadOnly(float const**,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.

Data Member Index


o _data
o _symbol
o _type

Constructor and Destructor


o CAT3DMarkerGP
public CAT3DMarkerGP()
Default constructor.
o CAT3DMarkerGP
public CAT3DMarkerGP( const iPoints,
const iNbPoints=1,
iSymbol= CROSS,
const 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.
o ~CAT3DMarkerGP
public virtual ~CAT3DMarkerGP()

Methods


o Draw
public virtual Draw( iRender)
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 Get( oPoints,
oNbPoint,
oSymbol)
Deprecated:
R216 see GetReadOnly for read access and CAT3DMarkerGPEditHelper for write access
o GetReadOnly
public GetReadOnly( oPoints,
oNbPoint,
oSymbol)
Retrieves marked points coordinates and the symbol type used to mark them. This method must be called this way: 
 float const* points;
 int nbPoints;
 SymbolType symbol;

 GetReadOnly(&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
public SetSymbolType( iSymbol)
sets the symbol used to mark the points to a new value.
Parameters:
iSymbol
The new symbol you wish to use.

Data Members


o _data 
  public _data
o _symbol 
  public unsigned short _symbol
o _type 
  public unsigned char _type
This object is included in the file: CAT3DMarkerGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.