Click or drag to resize
SbViewVolume Structure
3D viewing volume class.

Class used to represent a 3D viewing volume. This class is used to represent viewing frusta and picking volumes. For perspective projection, the view volume is a frustum. For orthographic (parallel) projection, the view volume is a rectangular prism.

Namespace: OIV.Inventor
Assembly: OIV.Inventor.SbLinear (in OIV.Inventor.SbLinear.dll) Version: 10.3.0.0.Release.e0557e69f65c2f4b712d9d57d8855c64671533f0
Syntax
public struct SbViewVolume

The SbViewVolume type exposes the following members.

Methods
  NameDescription
Public methodEquals(Object)
Returns a value indicating whether this instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(SbViewVolume, Single)
Returns a value indicating whether this instance is equal to a specified object with given tolerance.
Public methodEquals(SbViewVolume, Single)
Returns a value indicating whether this instance is equal to a specified object with given tolerance.
Public methodGetAlignRotation
Calls
GetAlignRotation(false)
.
Public methodGetAlignRotation(Boolean)
Returns a rotation that would align a viewed object so that its positive x-axis (of its object space) is to the right in the view and its positive y-axis is up.
Public methodGetBalanceAdjustment Obsolete.
Use BalanceAdjustment property instead.
Public methodGetCameraSpaceMatrix
Returns a matrix that transforms the view volume into camera space: it translates the view volume so the viewpoint is at the origin, and rotates it so the view direction is along the negative z axis.
Public methodGetDepth Obsolete.
Use Depth property instead.
Public methodGetHashCode
Returns the hash code for the value of this instance.
(Overrides ValueTypeGetHashCode.)
Public methodGetHeight Obsolete.
Use Height property instead.
Public methodGetMatrices
Returns two matrices corresponding to the view volume.
Public methodGetMatrix
Like the method GetMatrices(SbMatrix, SbMatrix), but returns the affine and projection parts together in one matrix (i.e.,
affine.MultRight(proj)
).
Public methodGetNearDist Obsolete.
Use NearDist property instead.
Public methodGetPlane
Returns a plane parallel to the near (or far) plane of the view volume at a given distance from the projection point (eye).
Public methodGetPlanePoint(Single, SbVec2f)
Returns the projection of a given point in normalized screen coordinates () onto the plane parallel to the near plane that is at distFromEye units from the eye.
Public methodGetPlanePoint(Single, SbVec2f)
Returns the projection of a given point in normalized screen coordinates () onto the plane parallel to the near plane that is at distFromEye units from the eye.
Public methodGetProjectedBbox(SbBox3f)
Projects the given 3D bounding box onto the near plane.
Public methodGetProjectedBbox(SbMatrix, SbBox3f)
Projects the given 3D bounding box onto the near plane.
Public methodGetProjectionDirection Obsolete.
Use ProjectionDir property instead.
Public methodGetProjectionPoint Obsolete.
Use ProjectionPoint property instead.
Public methodGetProjectionType Obsolete.
Use ProjType property instead.
Public methodGetSightPoint
Returns the point along the line of sight at the given distance from the projection point (eye).
Public methodGetStereoAdjustment Obsolete.
Use StereoAdjustment property instead.
Public methodGetStereoMode Obsolete.
Use StereoView property instead.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWidth Obsolete.
Use Width property instead.
Public methodGetWorldToScreenScale(SbVec3f, Single)
Returns a scale factor that would scale a unit sphere centered at worldCenter.
Public methodGetWorldToScreenScale(SbVec3f, Single)
Returns a scale factor that would scale a unit sphere centered at worldCenter.
Public methodIsBalanceNearFraction Obsolete.
Use BalanceNearFraction property instead.
Public methodIsStereoAbsoluteAdjustments Obsolete.
Use StereoAbsoluteAdjustments property instead.
Public methodNarrow(SbBox3f)
Narrows a view volume by the given box.
Public methodNarrow(SbBox3f)
Narrows a view volume by the given box.
Public methodNarrow(Single, Single, Single, Single)
Narrows the view to the given sub-rectangle.
Public methodOrtho
Sets up an orthographic view volume with the given sides.
Public methodPerspective
Sets up a perspective view volume with the given field of view and aspect ratio.
Public methodProjectBox(SbBox3f)
Projects the given 3D bounding box onto the near plane and returns the size (in normalized screen coordinates) of the rectangular region that encloses it.
Public methodProjectBox(SbBox3f)
Projects the given 3D bounding box onto the near plane and returns the size (in normalized screen coordinates) of the rectangular region that encloses it.
Public methodProjectFromScreen(SbVec3f)
Maps a 3D point in normalized screen coordinates (0 <= x,y,z <= 1) to a 3D world point.
Public methodProjectFromScreen(SbVec3f, SbVec3f)
Maps a 3D point in normalized screen coordinates (0 <= x,y,z <= 1) to a 3D world point.
Public methodProjectPointToLine(SbVec2f, SbLine)
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
Public methodProjectPointToLine(SbVec2f, SbLine)
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
Public methodProjectPointToLine(SbVec2f, SbVec3f, SbVec3f)
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
Public methodProjectPointToLine(SbVec2f, SbVec3f, SbVec3f)
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
Public methodProjectToScreen(SbVec3f)
Maps the 3D point in world coordinates to a 2D point in normalized screen coordinates (0 <= x,y,z <= 1). The z-screen coordinate represents the homogeneous z coordinate which goes (nonlinearly) from 0 at the near clipping plane to 1 at the far clipping plane.
Public methodProjectToScreen(SbVec3f, SbVec3f)
Maps the 3D point in world coordinates to a 2D point in normalized screen coordinates (0 <= x,y,z <= 1). The z-screen coordinate represents the homogeneous z coordinate which goes (nonlinearly) from 0 at the near clipping plane to 1 at the far clipping plane.
Public methodProjectToScreen(SbVec3f, SbVec3f)
Maps the 3D point in world coordinates to a 2D point in normalized screen coordinates (0 <= x,y,z <= 1). The z-screen coordinate represents the homogeneous z coordinate which goes (nonlinearly) from 0 at the near clipping plane to 1 at the far clipping plane.
Public methodRotateCamera(SbRotation)
Rotate the camera view direction.
Public methodRotateCamera(SbRotation)
Rotate the camera view direction.
Public methodScale
Scales width and height of view volume by given factor.
Public methodScaleHeight
Scales the view volume.
Public methodScaleWidth
Scales the view volume.
Public methodSetBalanceAdjustment
Sets the parallax balance.
Public methodSetStereoAbsoluteAdjustments Obsolete.
Use StereoAbsoluteAdjustments property instead.
Public methodToString
Returns the fully qualified type name of this instance.
(Inherited from ValueType.)
Public methodTranslateCamera(SbVec3f)
Translate the camera viewpoint.
Public methodTranslateCamera(SbVec3f)
Translate the camera viewpoint.
Public methodZNarrow
Computes a narrowed view volume.
Public methodZVector
Returns the positive z axis in eye space.
Top
Operators
  NameDescription
Public operatorStatic memberEquality
The equality operator.
Public operatorStatic memberInequality
The inequality operator.
Top
Properties
  NameDescription
Public propertyBalanceAdjustment
Gets the parallax balance. .
Public propertyBalanceNearFraction
Flag which indicates if the stereo balance adjustment is defined as a fraction of the camera near distance.
Public propertyDepth
Gets the depth of viewing frustum.
Public propertyHeight
Gets the height of viewing frustum.
Public propertyNearDist
Gets the distance from projection point to near plane.
Public propertyProjectionDir
Gets the projection direction.
Public propertyProjectionPoint
Gets the projection point.
Public propertyProjType
Gets the current projection type.
Public propertyStereoAbsoluteAdjustments
Specifies that stereo adjustments are absolute. false by default.
Public propertyStereoAdjustment
Gets or sets the stereo offset. .
Public propertyStereoView
Gets or sets the stereo mode.
Public propertyWidth
Gets the width of viewing frustum.
Top
See Also