VisualizationFoundation CAT2DArrowSymbolGP

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


public class CAT2DArrowSymbolGP

Class to create a dynamic graphic primitive of a 2D arrow symbol.


Constructor and Destructor Index


o CAT2DArrowSymbolGP()
Constructs a default graphic primitive of a two dimensional arrow symbol.
o CAT2DArrowSymbolGP(float[2],float[2],float,float,CATSymbolType,int)
Constructs a 2D arrow symbol Graphic primitive.

Method Index


o Get(float**,float**,float*,float*,CATSymbolType*,int*)
Retrieve Data of 2D arrow symbol.
o ImmediateDraw(CATRender&,CATViewpoint*,CATViewport*)
Draws a 2D arrow symbol.

Constructor and Destructor


o CAT2DArrowSymbolGP
public CAT2DArrowSymbolGP()
Constructs a default graphic primitive of a two dimensional arrow symbol.
o CAT2DArrowSymbolGP
public CAT2DArrowSymbolGP( const iPoint,
const iDirection,
const iSize_in_mm,
const iAngle,
iSymbol,
const iZoom= 0)
Constructs a 2D arrow symbol Graphic primitive.
Parameters:
iPoint
the position of the 2D arrow symbol.
This is the point which represents the top of the 2D arrow symbol.
iDirection
the direction vector of the 2D arrow symbol.
The direction vector is assumed to be normalized
iSize_in_mm
the size of the 2D arrow symbol among the axis defined by the Direction vector.
iAngle
the angle (in radians) formed by the line going from iPoint and directed by iDirection, and one of the slanted arrowhead lines. It determines how wide the arrowhead is at the base.
iSymbol
the type of 2D arrow symbol.
legal values:
OPEN_ARROW : arrow drawn with two symetric segments with respect to the vector director
UNFILLED_ARROW : unfilled arrow drawn with three segments.
FILLED ARROW : filled arrow drawn with three segments.
BLANKER_ARROW : arrow drawn with three segments. This arrow is composed of two arrows: one is an UNFILLED_ARROW 2D arrow and the other one is a FILLED_ARROW 2D arrow which has the color of the background.
iZoom
the type of size values.
legal values:
0 : size is expressed in millimeter.
1 : size is expressed in model unit.

Methods


o Get
public Get( oPoint,
oDirection,
oSize,
oAngle,
oSymbol,
oZoom)
Retrieve Data of 2D arrow symbol.
Parameters:
oPoint
the position of the 2D arrow symbol.
This is the point which represents the top of the 2D arrow symbol.
oDirection
the direction vector of the 2D arrow symbol.
The direction vector is assumed to be normalized
oSize
the size of the 2D arrow symbol among the axis defined by the Direction vector.
oAngle
the angle (in radians) formed by the line going from iPoint and directed by iDirection, and one of the slanted arrowhead lines. It determines how wide the arrowhead is at the base.
oSymbol
the type of 2D arrow symbol.
legal values:
OPEN_ARROW : arrow drawn with two symetric segments with respect to the vector director
UNFILLED_ARROW : unfilled arrow drawn with three segments.
FILLED ARROW : filled arrow drawn with three segments.
BLANKER_ARROW : arrow drawn with three segments. This arrow is composed of two arrows: one is an UNFILLED_ARROW 2D arrow and the other one is a FILLED_ARROW 2D arrow which has the color of the background.
oZoom
the type of size values.
legal values:
0 : size is expressed in millimeter.
1 : size is expressed in model unit.
o ImmediateDraw
public virtual ImmediateDraw( iRender,
const iViewpoint,
const iViewport)
Draws a 2D arrow symbol.
Parameters:
iRender
the render used to draw the 2D arrow symbol.
iViewpoint
the viewpoint used to draw the 2D arrow symbol.
iViewport
the viewport used to draw the 2D arrow symbol.

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

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