VisualizationFoundation CAT3DFixedArrowGP

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

public class CAT3DFixedArrowGP

Class to create the graphic primitive of a 3D fixed arrow.
Role: Graphic primitive to display a 3D arrow which size remains constant on the screen (i.e., does not change with zoom, etc...).

Constructor and Destructor Index


o CAT3DFixedArrowGP()
Default constructor
o CAT3DFixedArrowGP(CATMathPointf&,CATMathDirectionf&,int,int,int)
Constructs a 3D fixed arrow from an origin, the arrow direction, the normal to the plan containing the arrow head, the arrow total length, the arrow head height and an lenght indicating the offset desired between the origin and the arrow start point.
o CAT3DFixedArrowGP(CATMathPointf&,CATMathDirectionf&,CATMathDirectionf&,int)
Constructs a 3D fixed arrow from a start point, a direction, the normal to the plan containing this arrow, and its total length.

Method Index


o AssociateText(char*)
Associates some text to the 3D fixed arrow.
o Get(CATMathPointf&,CATMathDirectionf&,CATMathDirectionf&)
Retrieves the 3D fixed arrow parameters.
o ImmediateDraw(CATRender&,CATViewpoint*,CATViewport*)
Draws the 3D fixed arrow.

Constructor and Destructor


o CAT3DFixedArrowGP
public CAT3DFixedArrowGP()
Default constructor
o CAT3DFixedArrowGP
public CAT3DFixedArrowGP( const iOrigin,
const iDirection,
const iLengthIn_mm,
const iArrowHeadHeight= 0,
const iBaseLength= 0)
Constructs a 3D fixed arrow from an origin, the arrow direction, the normal to the plan containing the arrow head, the arrow total length, the arrow head height and an 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
      <----------->                                                    <------------>

                                           iLenghtIn_mm
                     <--------------------------------------------------------------->
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.
iLengthIn_mm
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.
o CAT3DFixedArrowGP
public CAT3DFixedArrowGP( const iStartPoint,
const iDirection,
const iNormal,
const iLengthIn_mm)
Constructs a 3D fixed arrow from a start point, a direction, the normal to the plan containing this arrow, and its total length. 

                                     /|\
                                      |
                                      |   iNormal 
                                      |
                                      ---------->
                                      iDirection 
 
                iStartPoint                                           XXXX
                                                                      XX XXX
                                                                      XX   XXX
                  X   X                                               XX     XXX
                   X X                                                XX       XXX
                    XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX         XXX 
                   X X                                                XX       XXX
                  X   X                                               XX      XXX
                                                                      XX    XXX
                                                                      XX  XXX
                                                                      XXXX
                


                                           iLenghtIn_mm
                     <--------------------------------------------------------------->
Parameters:
iStartPoint
The 3D start point of the 3D arrow.
iDirection
The arrow direction.
iNormal
The normal to the plan containing the arrow.
iLengthIn_mm
The arrow total length, expressed in millimetres.

Methods


o AssociateText
public AssociateText( iText)
Associates some text to the 3D fixed arrow. This text is displayed near the 3D fixed arrow.
Parameters:
iText
The characters string containing the text to associate to the arrow.
o Get
public virtual Get( oBegin,
oDirection,
oNormal)
Retrieves the 3D fixed arrow parameters.
Parameters:
oBegin
The 3D start point of the 3D arrow.
oDirection
The arrow direction.
oNormal
The normal to the plan containing the arrow.
o ImmediateDraw
public virtual ImmediateDraw( iRender,
const iViewpoint,
const iViewport)
Draws the 3D fixed 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: CAT3DFixedArrowGP.h
If needed, your Imakefile.mk should include the module: CATVisFoundation

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