All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Class CATFrm3DCamera

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ApplicationFrame.CATFrmCamera
        |
        +---CATFrm3DCamera
 

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


public class CATFrm3DCamera


Deprecated:
V5R16
Instead, use the factory CATCreateDefaultCamera in CATCameraToolkit to create a camera and the APIs of the interface CATICamera and CATI3DCamera
Implementation class of the CATI3DCamera interface.
Role:This implementation class provides methods to manage parameters of a 3D camera.
See also:
CAT3DViewpoint


Constructor and Destructor Index


o CATFrm3DCamera(CATUnicodeString)
Constructs a 3D camera with default parameters.
o CATFrm3DCamera(CATUnicodeString,CATMathPoint,CATMathDirection,CATMathDirection)
Constructs a 3D camera.
o ~CATFrm3DCamera()

Method Index


o CopyFrom(CATICamera*)
Makes a 3D camera identical with another one in copying all its parameters.
o GetDirection()
Returns the sight direction of a 3D camera.
o GetOrigin()
Returns the origin (eye position) of a 3D camera.
o GetTarget()
Returns the target point of a 3D camera.
o GetViewAngle()
Returns the view angle of a 3D conic camera.
o GetZenith()
Returns the up direction of a 3D camera.
o GetZoom()
Returns the zoom value of a 3D cylindric camera.
o SetDirection(CATMathDirection)
Changes the sight direction of a 3D camera.
o SetOrigin(CATMathPoint)
Changes the origin of a 3D camera.
o SetTarget(CATMathPoint)
Changes the target point of a 3D camera.
o SetType(CATCameraType)
Changes the type of a 3D camera.
o SetViewAngle(CATAngle)
Changes the view angle of a 3D conic camera.
o SetZenith(CATMathDirection)
Changes the up direction of a 3D camera.
o SetZoom(double)
Changes the zoom value of a 3D cylindric camera.

Constructor and Destructor


o CATFrm3DCamera
public CATFrm3DCamera(CATUnicodeString iName)
Constructs a 3D camera with default parameters.
Parameters:
iName
the name of the 3D camera.
o CATFrm3DCamera
public CATFrm3DCamera(CATUnicodeString iName,
CATMathPoint iOrigin,
CATMathDirection iDirection,
CATMathDirection iZenith)
Constructs a 3D camera.
Parameters:
iName
the name of the 3D camera.
iOrigin
the origin of the 3D camera.
iDirection
the sight direction of the 3D camera (must be perpendicular to the up direction).
iZenith
the up direction of the 3D camera (must be perpendicular to the sight direction).
o ~CATFrm3DCamera
public virtual ~CATFrm3DCamera()

Methods


o CopyFrom
public virtual void CopyFrom(CATICamera* iCamera)
Makes a 3D camera identical with another one in copying all its parameters.
Parameters:
iCamera
camera to copy.
o GetDirection
public virtual CATMathDirection GetDirection()
Returns the sight direction of a 3D camera.
Returns:
a CATMathDirection value
o GetOrigin
public virtual CATMathPoint GetOrigin()
Returns the origin (eye position) of a 3D camera.
Returns:
a CATMathPoint value
o GetTarget
public virtual CATMathPoint GetTarget()
Returns the target point of a 3D camera.
Returns:
a CATMathPoint value
o GetViewAngle
public virtual CATAngle GetViewAngle()
Returns the view angle of a 3D conic camera. It is the half of the vertical vision field angle (in degrees).
Returns:
a CATAngle value
o GetZenith
public virtual CATMathDirection GetZenith()
Returns the up direction of a 3D camera.
Returns:
a CATMathDirection value
o GetZoom
public virtual double GetZoom()
Returns the zoom value of a 3D cylindric camera.
Returns:
a double value
o SetDirection
public virtual void SetDirection(CATMathDirection iDirection)
Changes the sight direction of a 3D camera. It results a rotation of the camera around it's origin.
Parameters:
iDirection
New sight direction of the camera. This direction must be perpendicular to the up direction.
o SetOrigin
public virtual void SetOrigin(CATMathPoint iOrigin)
Changes the origin of a 3D camera. It results a translation of the camera.
Parameters:
iOrigin
New position of the camera origin.
o SetTarget
public virtual void SetTarget(CATMathPoint iTarget)
Changes the target point of a 3D camera. It results a change of the camera sight direction.
Parameters:
iTarget
New target point of the camera.
o SetType
public virtual void SetType(CATCameraType iCameraType)
Changes the type of a 3D camera.
Parameters:
iCameraType
New camera type.
Legal values:
  • CAT3DConicCamera 3D perspective projection
  • CAT3DCylindricCamera 3D parallel projection
  • .
  • CAT3DUnknownCamera Any type of 3D projection
  • o SetViewAngle
    public virtual void SetViewAngle(CATAngle iViewAngle)
    Changes the view angle of a 3D conic camera.
    Parameters:
    iViewAngle
    New view angle of the camera. It is the half of the vertical vision field angle (in degrees).
    o SetZenith
    public virtual void SetZenith(CATMathDirection iZenith)
    Changes the up direction of a 3D camera. It results a rotation of the camera around it's sight direction.
    Parameters:
    iZenith
    New up direction of the camera. This direction must be perpendicular to the sight direction.
    o SetZoom
    public virtual void SetZoom(double iZoom)
    Changes the zoom value of a 3D cylindric camera.
    Parameters:
    iZoom
    New zoom value of the camera. iZoom must be >=0 .

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

    Copyright © 2003, Dassault Systèmes. All rights reserved.