VisualizationFoundation CAT3DAnnotationTextGP

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

public class CAT3DAnnotationTextGP

Class to create a dynamic graphic primitive of 3D annotation text.
Role: These Graphic primitives have a continuous zoom.

Constructor and Destructor Index


o CAT3DAnnotationTextGP(CATMathPointf&,CATUnicodeString&,CATAnchorPoint,float,int)
Constructs a 3D annotation text Graphic primitive.

Method Index


o Get(float**,char**,CATAnchorPoint*,float*,int*)
Retrieves data about the 3D annotation text.

Constructor and Destructor


o CAT3DAnnotationTextGP
public CAT3DAnnotationTextGP( const iPoint,
const iString,
iPosition= BASE_LEFT,
const iHeight= 0.f,
const iContour= 0)
Constructs a 3D annotation text Graphic primitive.
Parameters:
iPoint
the position of the Graphic Primitive in a 3D space
iString
the string of characters which composes the text of the 3DAnnotationTextGP
iPosition
the position of iPoint with respect to string of the 3DAnnotationTextGP
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.

Methods


o Get
public Get( oPoint,
oText,
oAnchorpoint,
oHeight,
oContour)
Retrieves data about the 3D annotation text.
Parameters:
oPoint
the position of the Graphic Primitive in a 3D space. It is a 3D point.
oText
the string of characters which composes the text of the 3DAnnotationTextGP
oAnchorpoint
the position of oPoint with respect to string of the 3DAnnotationTextGP
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.
This object is included in the file: CAT3DAnnotationTextGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

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