All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VisualizationBase Class CAT2DMarkerGP

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---VisualizationBase.CATGraphicPrimitive
        |
        +---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.

Constructor and Destructor


o CAT2DMarkerGP
public CAT2DMarkerGP()
Default constructor.
o CAT2DMarkerGP
public CAT2DMarkerGP( const float[] iPoints,
const int iNb_point= 1,
CATSymbolType iSymbol= CROSS)
Constructs a 2D Marker Graphic primitive.
Parameters:
iPoints
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 void Draw(CATRender& iRender)
Draws the dynamic graphic primitive with a render.
Parameters:
iRender
the render used to draw the dynamic graphic primitive.
o Get
public inline void Get(float** oPoints,
int* oNb_point,
CATSymbolType* oSymbol) const
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

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

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