VisualizationFoundation CAT2DAnnotationTextGP

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

public class CAT2DAnnotationTextGP

Class to create a dynamic graphic primitive of 2D annotation text.
Role: These Graphic primitives have not a continuous zoom. There are various possible zoom values and current zoom is the zoom which is the nearest of possible zoom values.

See also:

Constructor and Destructor Index


o CAT2DAnnotationTextGP()
Default Constructor.
o CAT2DAnnotationTextGP(CATMathPoint2Df&,CATUnicodeString&,CATAnchorPoint,float,int,CATGraphicAttributeSet*,CATGraphicAttributeSet*)
Constructs a 2D annotation text Graphic primitive.

Method Index


o Get(float**,char**,CATAnchorPoint*,float*,int*,CATGraphicAttributeSet**,CATGraphicAttributeSet**)
Retrieves data about the 2D annotation text.
o Get(float**,CATUnicodeString&,CATAnchorPoint*,float*,int*,CATGraphicAttributeSet**,CATGraphicAttributeSet**)
o ImmediateDraw(CATRender&,CATViewpoint*,CATViewport*)
Draws a 2D Annotation text.

Constructor and Destructor


o CAT2DAnnotationTextGP
public CAT2DAnnotationTextGP()
Default Constructor.
o CAT2DAnnotationTextGP
public CAT2DAnnotationTextGP( const iPoint,
const iString,
iPosition= BASE_LEFT,
const iHeight= 0.f,
const iContour= 0,
const iContour1= NULL,
const iContour2= NULL)
Constructs a 2D annotation text Graphic primitive.
Parameters:
iPoint
the position of the Graphic Primitive in a 2D space
iString
the string of characters which composes the text of the 2DAnnotationTextGP
iPosition
the position of iPoint with respect to string of the 2DAnnotationTextGP
legal values:
   TOP_LEFT          TOP_CENTER       TOP_RIGHT
            +------------+-----------+
            !                        !
            !        BASE_CENTER     !
  BASE_LEFT +            +           + BASE_RIGHT
            !                        !
            +------------+-----------+
 BOTTOM_LEFT       BOTTOM_CENTER      BOTTOM_RIGHT
iHeight
the height of the Graphic Primitive
iContour
the integer which allows or does not allow to construct a contour around the Graphic Primitive.
legal values:
0 : no contour is constructed around the graphic primitive.
1 : a contour is constructed around the graphic primitive.
iContour1
the graphic attribute which defines graphic properties of top and left segments of the contour around the graphic primitive.
legal values: the default value is NULL.
iContour2
the graphic attribute which defines graphic properties of bottom and right segments of the contour around the graphic primitive.
legal values: the default value is NULL.

Methods


o Get
public Get( oPoint,
oText,
oAnchorpoint,
oHeight,
oContour,
oContour1,
oContour2)
Retrieves data about the 2D annotation text.
Parameters:
oPoint
the position of the Graphic Primitive in a 2D space. It is a 2D point.
oText
the string of characters which composes the text of the 2DAnnotationTextGP
oAnchorpoint
the position of oPoint with respect to string of the 2DAnnotationTextGP
legal values:
   TOP_LEFT          TOP_CENTER       TOP_RIGHT
            +------------+-----------+
            !                        !
            !        BASE_CENTER     !
  BASE_LEFT +            +           + BASE_RIGHT
            !                        !
            +------------+-----------+
 BOTTOM_LEFT       BOTTOM_CENTER      BOTTOM_RIGHT
oHeight
the height of the Graphic Primitive
oContour
the integer which allows or not allow to construct a contour around the graphic primitive.
legal values:
0 : no contour is constructed around the graphic primitive.
1 : a contour is constructed around the graphic primitive.
oContour1
the graphic attribute which defines graphic properties of top and left segments of the contour around the graphic primitive.
oContour2
the graphic attribute which defines graphic properties of bottom and right segments of the contour around the graphic primitive.
o Get
public Get( oPoint,
oText,
oAnchorpoint,
oHeight,
oContour,
oContour1,
oContour2)
o ImmediateDraw
public virtual ImmediateDraw( iRender,
const iViewpoint,
const iViewport)
Draws a 2D Annotation text.
Parameters:
iRender
the render used to draw the 2D annotation text.
iViewpoint
the viewpoint used to draw the 2D annotation text.
iViewport
the viewport used to draw the 2D annotation text.
This object is included in the file: CAT2DAnnotationTextGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

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