Click or drag to resize
SoCamera Class

Abstract base class for camera nodes.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.1.0 (10.16.1.0)
Syntax
public abstract class SoCamera : SoNode

The SoCamera type exposes the following members.

Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodAllowStereo Obsolete.

Allows the camera to render in stereo.

Public methodCallback
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBalanceAdjustment Obsolete.

Queries the parallax balance.

Public methodGetBoundingBox
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStereoAbsoluteAdjustment Obsolete.

Queries the stereo absolute adjustment state.

Public methodGetStereoAdjustment Obsolete.

Queries the stereo offset.

Public methodGetStereoMode

Queries the stereo mode.

Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViewportBounds

Returns the viewport region this camera would use to render into the given viewport region, accounting for cropping.

Public methodGetViewVolume
Calls GetViewVolume(0.0).
Public methodGetViewVolume(Single)

Returns a view volume object, based on the camera's viewing parameters.

Public methodGetViewVolume(Single, Single, Single, SbVec3f, SbRotation)

Computes a view volume from the given parameters.

Public methodGLRender
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBalanceAdjustmentNearFrac Obsolete.

Returns true if the stereo balance adjustement is defined as a fraction of the camera near distance.

Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodPointAt

Sets the orientation of the camera so that it points toward the given target point while keeping the "up" direction of the camera parallel to the positive y-axis.

Public methodRayPick
Public methodScaleHeight

Scales the height of the camera.

Public methodSearch
(Inherited from SoNode.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetBalanceAdjustment(Single) Obsolete.
Calls SetBalanceAdjustment(adjustment, false).
Public methodSetBalanceAdjustment(Single, Boolean) Obsolete.

Sets the stereo balance (the position of the zero parallax plane) and specifies whether the balance value is defined as a fraction of the camera near distance.

Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetStereoAbsoluteAdjustments Obsolete.

Specifies if stereo adjustments are absolute.

Public methodSetStereoAdjustment Obsolete.

Sets the stereo offset (the distance of each eye from the camera position).

Public methodSetStereoMode

Sets the stereo mode.

Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodViewAll(SbBox3f, SbViewportRegion)

Sets the camera to view the region defined by the given bounding box.

Public methodViewAll(SoNode, SbViewportRegion)
Calls ViewAll(sceneRoot, vpRegion, 1.0).
Public methodViewAll(SoPath, SbViewportRegion)
Calls ViewAll(path, vpRegion, 1.0).
Public methodViewAll(SoNode, SbViewportRegion, Single)

Sets the camera to view the scene rooted by the given node.

Public methodViewAll(SoPath, SbViewportRegion, Single)

Sets the camera to view the scene defined by the given path.

Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyaspectRatio

The ratio of camera viewing width to height.

Public propertyfarDistance

The distance from the camera viewpoint to the far clipping plane.

Public propertyfocalDistance

The distance from the viewpoint to the point of focus.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertynearDistance

The distance from the camera viewpoint to the near clipping plane.

Public propertyorientation

The orientation of the camera viewpoint, defined as a rotation of the viewing direction from its default (0,0,-1) vector.

Public propertyposition

The location of the camera viewpoint.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyviewportMapping

Defines how to map the rendered image into the current viewport, when the aspect ratio of the camera differs from that of the viewport.

Top
Remarks

This is the abstract base class for all camera nodes. It defines the common methods and fields that all cameras have. Cameras are used to view a scene. When a camera is encountered during rendering, it sets the projection and viewing matrices and viewport appropriately; it does not draw geometry. Cameras should be placed before any shape nodes or light nodes in a scene graph; otherwise, those shapes or lights cannot be rendered properly. Cameras are affected by the current transformation, so you can position a camera by placing a transformation node before it in the scene graph. The default position and orientation of a camera is at (0,0,1) looking along the negative z-axis.

You can also use a node kit to create a camera; see the reference page for OIV.Inventor.Nodekits.SoCameraKit.

Useful algorithms for manipulating a camera are provided in the OIV.Inventor.ViewerComponents.SoCameraInteractor class.

EXAMPLE

Compute the current view vector or up vector.

SoCamera camera . . .
SbRotation orientation = camera.orientation.Value;
SbVec3f upVec;
orientation.MultVec( new SbVec3f(0,1,0), out upVec );
SbVec3f vwVec;
orientation.MultVec( new SbVec3f(0,0,-1), out vwVec );

Shortcut to get the current view vector or up vector.

 SbMatrix mx;
 mx.SetRotate(camera.orientation.Value);
 SbVec3f upVec = new SbVec3f( mx[1,0],  mx[1,1],  mx[1,2] );
 SbVec3f vwVec = new SbVec3f(-mx[2,0], -mx[2,1], -mx[2,2]);

Compute the current focal point. \par
 \code
 SbMatrix mx;
 mx.SetRotate(camera.orientation.Value);
 SbVec3f vwVec = new SbVec3f(-mx[2,0], -mx[2,1], -mx[2,2]);
 SbVec3f focalPt = camera.position.Value
                 + camera.focalDistance.Value * vwVec;

See Also