enum ViewportMapping { CROP_VIEWPORT_FILL_FRAME, CROP_VIEWPORT_LINE_FRAME, CROP_VIEWPORT_NO_FRAME, ADJUST_CAMERA, LEAVE_ALONE }

enum StereoMode { MONOSCOPIC, LEFT_VIEW, RIGHT_VIEW }

virtual SoType getTypeId (void) const

void pointAt (const SbVec3f &targetpoint)

void pointAt (const SbVec3f &targetpoint, const SbVec3f &upvector)

virtual void scaleHeight (float scalefactor)=0

virtual SbViewVolume getViewVolume (float useaspectratio=0.0f) const =0

void viewAll (SoNode *const sceneroot, const SbViewportRegion &vpregion, const float slack=1.0f)

void viewAll (SoPath *const path, const SbViewportRegion &vpregion, const float slack=1.0f)

SbViewportRegion getViewportBounds (const SbViewportRegion &region) const

void setStereoMode (StereoMode mode)

StereoMode getStereoMode (void) const

void setStereoAdjustment (float adjustment)

float getStereoAdjustment (void) const

void setBalanceAdjustment (float adjustment)

float getBalanceAdjustment (void) const

virtual void doAction (SoAction *action)

virtual void callback (SoCallbackAction *action)

virtual void GLRender (SoGLRenderAction *action)

virtual void audioRender (SoAudioRenderAction *action)

virtual void getBoundingBox (SoGetBoundingBoxAction *action)

virtual void handleEvent (SoHandleEventAction *action)

virtual void rayPick (SoRayPickAction *action)

virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

static SoType getClassTypeId (void)

static void initClass (void)

SoSFEnum viewportMapping

SoSFVec3f position

SoSFRotation orientation

SoSFFloat aspectRatio

SoSFFloat nearDistance

SoSFFloat farDistance

SoSFFloat focalDistance

virtual const SoFieldData * getFieldData (void) const

SoCamera (void)

virtual ~SoCamera ()

virtual void viewBoundingBox (const SbBox3f &box, float aspect, float slack)=0

virtual void jitter (int numpasses, int curpass, const SbViewportRegion &vpreg, SbVec3f &jitteramount) const

static const SoFieldData ** getFieldDataPtr (void)

class SoCameraP

Enumerates the available possibilities for how the render frame should map the viewport.

Enumerates the possible stereo modes.

Enumerator:

MONOSCOPIC

No stereo.

LEFT_VIEW

Left view.

RIGHT_VIEW

Right view.

Constructor.

Destructor.

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoNode.

Reimplemented in SoOrthographicCamera, and SoPerspectiveCamera.

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Usage example:

  void foo(SoNode * node)
  {
    if (node->getTypeId() == SoFile::getClassTypeId()) {
      SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
    }
  }

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

Reimplemented in SoOrthographicCamera, and SoPerspectiveCamera.

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoNode.

Reimplemented in SoOrthographicCamera, and SoPerspectiveCamera.

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

Reimplemented in SoOrthographicCamera, and SoPerspectiveCamera.

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNode.

Reimplemented in SoOrthographicCamera, and SoPerspectiveCamera.

Reorients the camera so that it points towards targetpoint. The positive y-axis is used as the up vector of the camera, unless the new camera direction is parallel to this axis, in which case the positive z-axis will be used instead.

Reorients the camera so that it points towards targetpoint, using upvector as the camera up vector.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Sets a scalefactor for the height of the camera viewport. What 'viewport height' means exactly in this context depends on the camera model. See documentation in subclasses.

Implemented in SoOrthographicCamera, and SoPerspectiveCamera.

Returns total view volume covered by the camera under the current settings.

This view volume is not adjusted to account for viewport mapping. If you want the same view volume as the one used during rendering, you should do something like this:

  SbViewVolume vv;
  float aspectratio = myviewport.getViewportAspectRatio();

switch (camera->viewportMapping.getValue()) { case SoCamera::CROP_VIEWPORT_FILL_FRAME: case SoCamera::CROP_VIEWPORT_LINE_FRAME: case SoCamera::CROP_VIEWPORT_NO_FRAME: vv = camera->getViewVolume(0.0f); break; case SoCamera::ADJUST_CAMERA: vv = camera->getViewVolume(aspectratio); if (aspectratio < 1.0f) vv.scale(1.0f / aspectratio); break; case SoCamera::LEAVE_ALONE: vv = camera->getViewVolume(0.0f); break; default: assert(0 && "unknown viewport mapping"); break; }

.fi

Also, for the CROPPED viewport mappings, the viewport might be changed if the viewport aspect ratio is not equal to the camera aspect ratio. See SoCamera::getView() to see how this is done.

Implemented in SoOrthographicCamera, and SoPerspectiveCamera.

Position the camera so that all geometry of the scene from sceneroot is contained in the view volume of the camera, while keeping the camera orientation constant.

Finds the bounding box of the scene and calls SoCamera::viewBoundingBox(). A bounding sphere will be calculated from the scene bounding box, so the camera will 'view all' even when the scene is rotated, in any way.

The slack argument gives a multiplication factor to the distance the camera is supposed to move out from the sceneroot mid-point.

A value less than 1.0 for the slack argument will therefore cause the camera to come closer to the scene, a value of 1.0 will position the camera as exactly outside the scene bounding sphere, and a value larger than 1.0 will give 'extra slack' versus the scene bounding sphere.

Position the camera so all geometry of the scene in path is contained in the view volume of the camera.

Finds the bounding box of the scene and calls SoCamera::viewBoundingBox().

Based in the SoCamera::viewportMapping setting, convert the values of region to the viewport region we will actually render into.

Sets the stereo mode.

Returns the stereo mode.

Sets the stereo adjustment. This is the distance between the left and right 'eye' when doing stereo rendering.

Returns the stereo adjustment.

See also: setStereoAdjustment()

Sets the stereo balance adjustment. This is a factor that enables you to move the zero parallax plane. Objects in front of the zero parallax plane appears to be in front of the screen.

The default value is 1.0, and the zero parallax plane is then at the focal point (see SoCamera::focalDistance).

Returns the stereo balance adjustment.

See also: setBalanceAdjustment()

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Reimplemented from SoNode.

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

Picking actions can be triggered during handle event action traversal, and to do picking we need to know the camera state.

See also: SoCamera::rayPick()

Reimplemented from SoNode.

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node.

Nodes influencing relevant state variables for how picking is done also overrides this method.

Reimplemented from SoNode.

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

Convenience method for setting up the camera definition to cover the given bounding box with the given aspect ratio. Multiplies the exact dimensions with a slack factor to have some space between the rendered model and the borders of the rendering area.

If you define your own camera node class, be aware that this method should not set the orientation field of the camera, only the position, focal distance and near and far clipping planes.

Implemented in SoOrthographicCamera, and SoPerspectiveCamera.

Set up how the render frame should map the viewport. The default is SoCamera::ADJUST_CAMERA.

Camera position. Defaults to <0,0,1>.

Camera orientation specified as a rotation value from the default orientation where the camera is pointing along the negative z-axis, with 'up' along the positive y-axis.

E.g., to rotate the camera to point along the X axis:

  mycamera->orientation.setValue(SbRotation(SbVec3f(0, 1, 0), M_PI / 2.0f));

For queries, e.g. to get the current 'up' and 'look at' vectors of the camera:

  SbRotation camrot = mycamera->orientation.getValue();

SbVec3f upvec(0, 1, 0); // init to default up vector camrot.multVec(upvec, upvec);

SbVec3f lookat(0, 0, -1); // init to default view direction vector camrot.multVec(lookat, lookat);

Aspect ratio for the camera (i.e. width / height). Defaults to 1.0.

Distance from camera position to the near clipping plane in the camera's view volume.

Default value is 1.0. Value must be larger than 0.0, or it will not be possible to construct a valid viewing volume (for perspective rendering, at least).

If you use one of the viewer components from the So[Xt|Qt|Win|Gtk] GUI libraries provided by Systems in Motion, they will automatically update this value for the scene camera according to the scene bounding box. Ditto for the far clipping plane.

See also: SoCamera::farDistance

Distance from camera position to the far clipping plane in the camera's view volume.

Default value is 10.0. Must be larger than the SoCamera::nearDistance value, or it will not be possible to construct a valid viewing volume.

Note that the range [nearDistance, farDistance] decides the dynamic range of the Z-buffer in the underlying polygon-rendering rasterizer. What this means is that if the near and far clipping planes of the camera are wide apart, the possibility of visual artifacts will increase. The artifacts will manifest themselves in the form of flickering of primitives close in depth.

It is therefore a good idea to keep the near and far clipping planes of your camera(s) as closely fitted around the geometry of the scene graph as possible.

See also: SoCamera::nearDistance, SoPolygonOffset

Distance from camera position to center of scene.