SoPerspectiveCamera(3IV)

NAME
     SoPerspectiveCamera (SoPerspCam) - perspective camera node

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoCamera > SoPerspectiveCamera

SYNOPSIS
     #include <Inventor_c/nodes/SoPerspectiveCamera.h>

     typedef SoPerspectiveCamera  SoPerspCam

          Fields from class SoPerspectiveCamera:

     SoSFFloat           heightAngle

          Fields from class SoCamera:

     SoSFEnum            viewportMapping
     SoSFVec3f           position
     SoSFRotation        orientation
     SoSFFloat           aspectRatio
     SoSFFloat           nearDistance
     SoSFFloat           farDistance
     SoSFFloat           focalDistance

          Functions from class SoPerspectiveCamera:

     SoPerspectiveCamera *  SoPerspCamCreate()
     SoType                 SoPerspCamGetClassTypeId()

          Functions from class SoCamera:

     void                SoPerspCamPtAt(SoPerspCam *this, const SbVec3f
                              *targetPoint)
     void                SoPerspCamScaleHeight(SoPerspCam *this, float
                              scaleFactor)
     SbViewVolume        SoPerspCamGetViewVol(const SoPerspCam *this, float
                              useAspectRatio = 0.0)
     void                SoPerspCamViewAll(SoPerspCam *this, SoNode
                              *sceneRoot, const SbViewportRegion *vpRegion,
                              float slack = 1.0)
     void                SoPerspCamViewAllPath(SoPerspCam *this, SoPath *path,
                              const SbViewportRegion *vpRegion, float slack =
                              1.0)
     SbViewportRegion    SoPerspCamGetVpBounds(const SoPerspCam *this, const
                              SbViewportRegion *region)

          Functions from class SoNode:

     void                SoPerspCamSetOverride(SoPerspCam *this, SbBool state)
     SbBool              SoPerspCamIsOverride(const SoPerspCam *this)
     SoNode *            SoPerspCamCopy(const SoPerspCam *this, SbBool
                              copyConnections = FALSE)
     SbBool              SoPerspCamAffectsState(const SoPerspCam *this)
     SoNode *            SoPerspCamGetByName(const char *name)
     int                 SoPerspCamGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoPerspCamSetToDflts(SoPerspCam *this)
     SbBool              SoPerspCamHasDfltVals(const SoPerspCam *this)
     SbBool              SoPerspCamFldsAreEq(const SoPerspCam *this, const
                              SoFieldContainer *fc)
     void                SoPerspCamCopyFieldVals(SoPerspCam *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoPerspCamSet(SoPerspCam *this, const char
                              *fieldDataString)
     void                SoPerspCamGet(SoPerspCam *this, SbString
                              *fieldDataString)
     int                 SoPerspCamGetFields(const SoPerspCam *this,
                              SoFieldList *resultList)
     SoField *           SoPerspCamGetField(const SoPerspCam *this, const char
                              *fieldName)
     SbBool              SoPerspCamGetFieldName(const SoPerspCam *this, const
                              SoField *field, SbName *fieldName)
     SbBool              SoPerspCamIsNotifyEnabled(const SoPerspCam *this)
     SbBool              SoPerspCamEnableNotify(SoPerspCam *this, SbBool flag)

          Functions from class SoBase:

     void                SoPerspCamRef(SoPerspCam *this)
     void                SoPerspCamUnref(const SoPerspCam *this)
     void                SoPerspCamUnrefNoDelete(const SoPerspCam *this)
     void                SoPerspCamTouch(SoPerspCam *this)
     SoType              SoPerspCamGetTypeId(const SoPerspCam *this)
     SbBool              SoPerspCamIsOfType(const SoPerspCam *this, SoType
                              type)
     void                SoPerspCamSetName(SoPerspCam *this, const char *name)
     SbName              SoPerspCamGetName(const SoPerspCam *this)


DESCRIPTION
     A perspective camera defines a perspective projection from a viewpoint.
     The viewing volume for a perspective camera is a truncated right pyramid.

     By default, the camera is located at (0,0,1) and looks along the negative
     z-axis; the position and orientation fields can be used to change these
     values. The heightAngle field defines the total vertical angle of the
     viewing volume; this and the aspectRatio field determine the horizontal
     angle.
FIELDS
     SoSFFloat           heightAngle
          Vertical angle of the viewing volume.


FUNCTIONS
     SoPerspectiveCamera *  SoPerspCamCreate()
          Creates a perspective camera node with default settings.

     SoType                 SoPerspCamGetClassTypeId()
          Returns type identifier for this class.


ACTION BEHAVIOR
     SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction,
     SoHandleEventAction, SoRayPickAction
          Sets the viewport and camera information in the state.


FILE FORMAT/DEFAULTS
     PerspectiveCamera {
          viewportMapping  ADJUST_CAMERA
          position         0 0 1
          orientation      0 0 1  0
          aspectRatio      1
          nearDistance     1
          farDistance      10
          focalDistance    5
          heightAngle      0.785398
     }

SEE ALSO
     SbViewVolume, SoOrthographicCamera