Click or drag to resize
SoStereoCamera Class

Stereo camera node.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoStereoCamera : SoPerspectiveCamera

The SoStereoCamera type exposes the following members.

Constructors
  NameDescription
Public methodSoStereoCamera

Creates a stereo camera node with default settings.

Top
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.

(Overrides SoCameraAllowStereo(Boolean).)
Public methodCallback
(Inherited from SoCamera.)
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
(Inherited from SoCamera.)
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.

(Inherited from SoCamera.)
Public methodGetBoundingBox
(Inherited from SoCamera.)
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
(Inherited from SoCamera.)
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.

(Inherited from SoCamera.)
Public methodGetStereoAdjustment Obsolete.

Queries the stereo offset.

(Inherited from SoCamera.)
Public methodGetStereoMode

Queries the stereo mode.

(Inherited from SoCamera.)
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.

(Inherited from SoCamera.)
Public methodGetViewVolume
Calls GetViewVolume(0.0).
(Inherited from SoPerspectiveCamera.)
Public methodGetViewVolume(Single)

Fills in a view volume structure, based on the camera.

(Inherited from SoPerspectiveCamera.)
Public methodGetViewVolume(Single, Single, Single, SbVec3f, SbRotation)
(Inherited from SoPerspectiveCamera.)
Public methodGLRender
(Inherited from SoCamera.)
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
(Inherited from SoCamera.)
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.

(Inherited from SoCamera.)
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.

(Inherited from SoCamera.)
Public methodRayPick
(Inherited from SoCamera.)
Public methodScaleHeight

Scales the height of the camera, in this case, the OIV.Inventor.Nodes.SoPerspectiveCamera.heightAngle field.

(Inherited from SoPerspectiveCamera.)
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.
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetStereoAbsoluteAdjustments Obsolete.
Public methodSetStereoAdjustment Obsolete.
Public methodSetStereoMode

Sets the stereo mode.

(Inherited from SoCamera.)
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.

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

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

(Inherited from SoCamera.)
Public methodViewAll(SoPath, SbViewportRegion, Single)

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

(Inherited from SoCamera.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyabsoluteAdjustments

Specifies if stereo adjustments are absolute.

Public propertyaspectRatio

The ratio of camera viewing width to height.

(Inherited from SoCamera.)
Public propertybalance

The stereo balance (the position of the zero parallax plane).

Public propertybalanceNearFrac

Specifies whether the balance value is defined as a fraction of the camera near distance.

Public propertyfarDistance

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

(Inherited from SoCamera.)
Public propertyfocalDistance

The distance from the viewpoint to the point of focus.

(Inherited from SoCamera.)
Public propertyheightAngle

Vertical angle of the viewing volume.

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

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

(Inherited from SoCamera.)
Public propertyoffset

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

Public propertyorientation

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

(Inherited from SoCamera.)
Public propertyposition

The location of the camera viewpoint.

(Inherited from SoCamera.)
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.

(Inherited from SoCamera.)
Top
Remarks

A stereo camera defines a specific perspective camera for stereo support.

This class defines fields to store the stereo settings related to the camera:

  • Stereo offset: the distance of each eye from the camera position.

  • Stereo balance: the position of the zero parallax plane.

See the base class OIV.Inventor.Nodes.SoPerspectiveCamera for more information about the inherited fields.

FILE FORMAT/DEFAULT

StereoCamera {
offset 0.7
balance 1.0
balanceNearFrac false
absoluteAdjustments false
}

ACTION BEHAVIOR

Sets: OIV.Inventor.Elements.SoStereoElement

See Also