| 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: 2024.1.1.Release.7989217834dd2b99155f267b6c8c70f9feacdedd
SyntaxThe SbViewVolume type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Equals(Object) |
Returns a value indicating whether this instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).) |
| Equals(SbViewVolume, Single) |
Returns a value indicating whether this instance is equal to a specified object
with given tolerance.
|
| Equals(SbViewVolume, Single) |
Returns a value indicating whether this instance is equal to a specified object
with given tolerance.
|
| GetAlignRotation |
Calls GetAlignRotation(false) |
| GetAlignRotation(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.
|
| GetBalanceAdjustment | Obsolete.
Use BalanceAdjustment property instead.
|
| GetCameraSpaceMatrix |
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.
|
| GetDepth | Obsolete.
Use Depth property instead.
|
| GetHashCode |
Returns the hash code for the value of this instance.
(Overrides ValueTypeGetHashCode.) |
| GetHeight | Obsolete.
Use Height property instead.
|
| GetMatrices |
Returns two matrices corresponding to the view volume.
|
| GetMatrix |
Like the method GetMatrices(SbMatrix, SbMatrix), but returns the affine and projection
parts together in one matrix (i.e., affine.MultRight(proj) |
| GetNearDist | Obsolete.
Use NearDist property instead.
|
| GetPlane |
Returns a plane parallel to the near (or far)
plane of the view volume at a given distance from the
projection point (eye).
|
| GetPlanePoint(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.
|
| GetPlanePoint(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.
|
| GetProjectedBbox(SbBox3f) |
Projects the given 3D bounding box onto the near plane.
|
| GetProjectedBbox(SbMatrix, SbBox3f) |
Projects the given 3D bounding box onto the near plane.
|
| GetProjectionDirection | Obsolete.
Use ProjectionDir property instead.
|
| GetProjectionPoint | Obsolete.
Use ProjectionPoint property instead.
|
| GetProjectionType | Obsolete.
Use ProjType property instead.
|
| GetSightPoint |
Returns the point along the line of sight
at the given distance from the projection point (eye).
|
| GetStereoAdjustment | Obsolete.
Use StereoAdjustment property instead.
|
| GetStereoMode | Obsolete.
Use StereoView property instead.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetWidth | Obsolete.
Use Width property instead.
|
| GetWorldToScreenScale(SbVec3f, Single) |
Returns a scale factor that would scale a unit sphere centered at
worldCenter.
|
| GetWorldToScreenScale(SbVec3f, Single) |
Returns a scale factor that would scale a unit sphere centered at
worldCenter.
|
| IsBalanceNearFraction | Obsolete.
Use BalanceNearFraction property instead.
|
| IsStereoAbsoluteAdjustments | Obsolete.
Use StereoAbsoluteAdjustments property instead.
|
| Narrow(SbBox3f) |
Narrows a view volume by the given box.
|
| Narrow(SbBox3f) |
Narrows a view volume by the given box.
|
| Narrow(Single, Single, Single, Single) | Narrows the view to the given sub-rectangle. |
| Ortho |
Sets up an orthographic view volume with the given sides.
|
| Perspective |
Sets up a perspective view volume with the given field of view and aspect ratio.
|
| ProjectBox(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.
|
| ProjectBox(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.
|
| ProjectFromScreen(SbVec3f) |
Maps a 3D point in normalized screen coordinates (0 <= x,y,z <= 1)
to a 3D world point.
|
| ProjectFromScreen(SbVec3f, SbVec3f) |
Maps a 3D point in normalized screen coordinates (0 <= x,y,z <= 1)
to a 3D world point.
|
| ProjectPointToLine(SbVec2f, SbLine) |
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
|
| ProjectPointToLine(SbVec2f, SbLine) |
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
|
| ProjectPointToLine(SbVec2f, SbVec3f, SbVec3f) |
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
|
| ProjectPointToLine(SbVec2f, SbVec3f, SbVec3f) |
Maps a 2D point (in 0 <= x,y <= 1) to a 3D line.
|
| ProjectToScreen(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.
|
| ProjectToScreen(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.
|
| ProjectToScreen(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.
|
| RotateCamera(SbRotation) |
Rotate the camera view direction.
|
| RotateCamera(SbRotation) |
Rotate the camera view direction.
|
| Scale |
Scales width and height of view volume by given factor.
|
| ScaleHeight |
Scales the view volume.
|
| ScaleWidth |
Scales the view volume.
|
| SetBalanceAdjustment |
Sets the parallax balance.
|
| SetStereoAbsoluteAdjustments | Obsolete.
Use StereoAbsoluteAdjustments property instead.
|
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
| TranslateCamera(SbVec3f) |
Translate the camera viewpoint.
|
| TranslateCamera(SbVec3f) |
Translate the camera viewpoint.
|
| ZNarrow |
Computes a narrowed view volume.
|
| ZVector | Returns the positive z axis in eye space. |
Operators| Name | Description | |
|---|---|---|
  | Equality |
The equality operator.
|
| Inequality |
The inequality operator.
|
Properties| Name | Description | |
|---|---|---|
 | BalanceAdjustment |
Gets the parallax balance. .
|
| BalanceNearFraction |
Flag which indicates if the stereo balance adjustment is defined as a fraction
of the camera near distance.
|
| Depth |
Gets the depth of viewing frustum.
|
| Height |
Gets the height of viewing frustum.
|
| NearDist |
Gets the distance from projection point to near plane.
|
| ProjectionDir |
Gets the projection direction.
|
| ProjectionPoint |
Gets the projection point.
|
| ProjType |
Gets the current projection type.
|
| StereoAbsoluteAdjustments |
Specifies that stereo adjustments are absolute. false by default.
|
| StereoAdjustment |
Gets or sets the stereo offset. .
|
| StereoView |
Gets or sets the stereo mode.
|
| Width |
Gets the width of viewing frustum.
|
See Also