VisualizationFoundation CAT2DMarkerGP

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

public class CAT2DMarkerGP

Class to create a dynamic graphic primitive of a 2D Marker.
Role: A 2D Marker has a fixed zoom. Its size in pixel does not change. It can be composed of various representations of a same symbol placed in diferents positions.

Constructor and Destructor Index


o CAT2DMarkerGP()
Default constructor.
o CAT2DMarkerGP(float[],int,CATSymbolType)
Constructs a 2D Marker Graphic primitive.

Method Index


o Draw(CATRender&)
Draws the dynamic graphic primitive with a render.
o Get(float**,int*,CATSymbolType*)
Retrieves data about the 2D Marker.
o GetSymbol(CATSymbolType&)
Retrieves the 2D Marker type.
o SetSymbol(CATSymbolType)
Defines the 2D Marker type.

Constructor and Destructor


o CAT2DMarkerGP
public CAT2DMarkerGP()
Default constructor.
o CAT2DMarkerGP
public CAT2DMarkerGP( const iPoints,
const iNb_point= 1,
iSymbol= CROSS)
Constructs a 2D Marker Graphic primitive.
Parameters:
iPoint
array which describes positions of each symbol which compose the 2D Marker (XYXYXY...). Its size is iNb_point*2.
iNb_point
total number of symbol to create.
legal values: The default value is 1. So by default a 2D marker contains just one symbol.
iSymbol
the type of 2D Marker. All symbols which compose the 2D marker have the same type.
legal values:
  • CROSS : a cross which looks like a "X".
  • PLUS : a cross which looks like a "+"
  • CONCENTRIC : an unfilled circle
  • COINCIDENT : two unfilled concentric circles
  • FULLCIRCLE : a filled circle
  • FULLSQUARE : a filled square
  • STAR : a star which is the union of a 2D marker CROSS ,a 2D marker PLUS and a 2D marker DOT
  • DOT : a dot
  • SMALLDOT : a smalldot (one pixel)
  • MISC1 : a kind of arrow which points to the bottom-left 
    	     /
	|  /
	|/__
  • MISC2 : a kind of arrow which points to the top-rigth 
    	    ___ 	
	      /|
	    /  |
	  /
  • FULLCIRCLE2 : a big FULLCIRCLE
  • FULLSQUARE2 : a big FULLSQUARE

By default, the 2D marker represents a CROSS.

Methods


o Draw
public virtual Draw( iRender)
Draws the dynamic graphic primitive with a render.
Parameters:
iRender
the render used to draw the dynamic graphic primitive.
o Get
public Get( oPoints,
oNb_point,
oSymbol)
Retrieves data about the 2D Marker.
Parameters:
oPoints
array which describes positions of each symbol which compose the 2D Marker (XYXYXY...). Its size is iNb_point*2.
oNb_point
total number of symbols which composed the 2D marker.
oSymbol
the type of 2D Marker. All symbols which compose the 2D marker have the same type.
legal values:
  • CROSS : a cross which looks like a "X".
  • PLUS : a cross which looks like a "+"
  • CONCENTRIC : an unfilled circle
  • COINCIDENT : two unfilled concentric circles
  • FULLCIRCLE : a filled circle
  • FULLSQUARE : a filled square
  • STAR : a star which is the union of a 2D marker CROSS ,a 2D marker PLUS and a 2D marker DOT
  • DOT : a dot
  • SMALLDOT : a smalldot (one pixel)
  • MISC1 : a kind of arrow which points to the bottom-left 
    	     /
	|  /
	|/__
  • MISC2 : a kind of arrow which points to the top-rigth 
    	    ___ 	
	       /|
	     /  |
	   /
  • FULLCIRCLE2 : a big FULLCIRCLE
  • FULLSQUARE2 : a big FULLSQUARE
o GetSymbol
public GetSymbol( oSymbol)
Retrieves the 2D Marker type.
Parameters:
oSymbol
The type of the 2D Marker.
o SetSymbol
public SetSymbol( iSymbol)
Defines the 2D Marker type.
Parameters:
iSymbol
The type of the 2D Marker.
This object is included in the file: CAT2DMarkerGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

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