VisualizationFoundation class CAT3DArrowGP

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

public class CAT3DArrowGP

Class to create the graphic primitive of a 3D arrow.
Role: Graphic primitive to display a 3D arrow

Constructor and Destructor Index


o CAT3DArrowGP()
Default constructor
o CAT3DArrowGP(CATMathPointf&,CATMathDirectionf&,int,int,int)
Constructs a 3D arrow with parameters.

Method Index


o AssociateText(char*)
Associates a text to the 3D arrow.
o ImmediateDraw(CATRender&,CATViewpoint*,CATViewport*)
Draws the 3D arrow.

Constructor and Destructor


o CAT3DArrowGP
public CAT3DArrowGP()
Default constructor
o CAT3DArrowGP
public CAT3DArrowGP( const CATMathPointf& iOrigin,
const CATMathDirectionf& iDirection,
const int iLength,
const int iArrowHeadHeight= 0,
const int iBaseLength= 0)
Constructs a 3D arrow with parameters.
Role: Constructs a 3D arrow from an origin, the arrow direction, the arrow total length, the arrow head height and a lenght indicating the offset desired between the origin and the arrow start point. 
                                      ---------->
                                      iDirection 
 
                                                                      XXXX
                                                                      XX XXX
                                                                      XX   XXX
                                                                      XX     XXX
     | iOrigin                                                        XX       XXX
   --|--             XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX         XXX 
     |                                                                XX       XXX
                                                                      XX      XXX
                                                                      XX    XXX
                                                                      XX  XXX
                                                                      XXXX
                

       iBaseLength                                                    iArrowHeadHeight
      <----------->                                                    <------------>

                                           iLenght
                     <--------------------------------------------------------------->
Parameters:
iOrigin
The arrow origin. If no iBaseLength is specified, or if it is set to 0, iOrigin corresponds to the arrow start point.
iDirection
The arrow direction.
iLength
The total arrow length, from start point to arrow head tip point, expressed in millimetres.
iArrowHeadHeight
The height of the arrow head. If no value is specified, iArrowHeadHeight is set to 0, and the arrow head height to iLengthIn_mm/5.
iBaseLength
An offset you can set to set the arrow start point at a certain distance from iOrigin. If no value is specified, the origin corresponds to the arrow start point.

Methods


o AssociateText
public void AssociateText(char* iText)
Associates a text to the 3D arrow.
Parameters:
iText
The characters string containing the text to associate to the arrow. This text is displayed near the 3D arrow.
o ImmediateDraw
public virtual void ImmediateDraw(CATRender& iRender,
const CATViewpoint* iViewpoint,
const CATViewport* iViewport)
Draws the 3D arrow.
Parameters:
iRender
The render through which the arrow is drawn.
iViewpoint
The viewpoint through which the arrow is seen.
iViewport
The viewport in which the arrow is located.
This object is included in the file: CAT3DArrowGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

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