PerspectiveViewVolume Class

Represents a perspective view volume (frustum).

Inheritance Hierarchy

SystemObject
  DigitalRune.Geometry.ShapesShape
    DigitalRune.Geometry.ShapesConvexShape
      DigitalRune.Geometry.ShapesViewVolume
        DigitalRune.Geometry.ShapesPerspectiveViewVolume

Namespace: DigitalRune.Geometry.Shapes
Assembly: DigitalRune.Geometry (in DigitalRune.Geometry.dll) Version: 1.18.0.0 (1.18.2.14427)

Syntax

C++

Copy

[SerializableAttribute]
public class PerspectiveViewVolume : ViewVolume

<SerializableAttribute>
Public Class PerspectiveViewVolume
	Inherits ViewVolume

[SerializableAttribute]
public ref class PerspectiveViewVolume : public ViewVolume

[<SerializableAttribute>]
type PerspectiveViewVolume =  
    class
        inherit ViewVolume
    end

The PerspectiveViewVolume type exposes the following members.

Constructors

	Name	Description
	PerspectiveViewVolume	Initializes a new instance of the PerspectiveViewVolume class using default settings.
	PerspectiveViewVolume(Single, Single, Single, Single)	Initializes a new instance of the PerspectiveViewVolume class with the given field of view and depth.

Top

Methods

	Name	Description
	Clone	Creates a new Shape that is a clone (deep copy) of the current instance. (Inherited from Shape.)
	CloneCore	Makes the instance a clone (deep copy) of the specified Shape. (Overrides ShapeCloneCore(Shape).)
	CreateInstanceCore	When implemented in a derived class, creates a new instance of the Shape derived class. (Overrides ShapeCreateInstanceCore.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAabb	Computes the axis-aligned bounding box (AABB) for this shape in local space. (Inherited from Shape.)
	GetAabb(Pose)	Computes the axis-aligned bounding box (AABB) for this shape positioned in world space using the given Pose. (Inherited from Shape.)
	GetAabb(Vector3F, Pose)	Computes the axis-aligned bounding box (AABB) for this shape positioned in world space using the given scale and Pose. (Inherited from ConvexShape.)
	GetExtent	Gets the extent of the frustum at the given distance.
	GetFieldOfView	Gets the field of view from a frustum with the given extent.
	GetFieldOfViewX	Converts the vertical field of view of a symmetric frustum to a horizontal field of view.
	GetFieldOfViewY	Converts a horizontal field of view of a symmetric frustum to a vertical field of view.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetMesh	Gets a mesh that represents this shape. (Inherited from Shape.)
	GetSupportPoint(Vector3F)	Gets a support point for a given direction. (Overrides ConvexShapeGetSupportPoint(Vector3F).)
	GetSupportPoint(Vector3F, Vector3F)	Gets a support point for a given direction and a given non-uniform scaling. (Inherited from ConvexShape.)
	GetSupportPointNormalized	Gets a support point for a given normalized direction vector. (Overrides ConvexShapeGetSupportPointNormalized(Vector3F).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVolume	Gets the volume of this shape.
	GetVolume(Single, Int32)	Gets the volume of this shape. (Overrides ShapeGetVolume(Single, Int32).)
	GetWidthAndHeight	Converts a field of view of a symmetric frustum to width and height.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnChanged	Raises the Changed event. (Inherited from Shape.)
	OnGetMesh	Called when a mesh should be generated for the shape. (Overrides ConvexShapeOnGetMesh(Single, Int32).)
	Set(Single, Single, Single, Single)	Sets the dimensions of the view volume. (Inherited from ViewVolume.)
	Set(Single, Single, Single, Single, Single, Single)	Sets the dimensions of the view volume (including depths). (Inherited from ViewVolume.)
	SetFieldOfView(Single, Single)	Sets the dimensions of the frustum to the specified field of view.
	SetFieldOfView(Single, Single, Single, Single)	Sets the dimensions of the frustum to the specified field of view and near/far values.
	SetWidthAndHeight(Single, Single)	Sets the width and height of the view volume to the specified size. (Inherited from ViewVolume.)
	SetWidthAndHeight(Single, Single, Single, Single)	Sets the width and height of the view volume to the specified size and depth. (Inherited from ViewVolume.)
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)
	Update	Updates the shape. (Overrides ViewVolumeUpdate.)

Top

Properties

	Name	Description
	AspectRatio	Gets the aspect ratio (width / height). (Inherited from ViewVolume.)
	Bottom	Gets or sets the minimum y-value of the view volume at the near clip plane. (Inherited from ViewVolume.)
	Depth	Gets the depth of the view volume (= Far - Near). (Inherited from ViewVolume.)
	Far	Gets or sets the distance to the far clip plane. (Inherited from ViewVolume.)
	FieldOfViewX	Gets the horizontal field of view. (Overrides ViewVolumeFieldOfViewX.)
	FieldOfViewY	Gets the vertical field of view. (Overrides ViewVolumeFieldOfViewY.)
	Height	Gets the height of the view volume at the near clip plane. (Inherited from ViewVolume.)
	InnerPoint	Gets an inner point. (Overrides ShapeInnerPoint.)
	Left	Gets or sets the minimum x-value of the view volume at the near clip plane. (Inherited from ViewVolume.)
	Near	Gets or sets the distance to the near clip plane. (Inherited from ViewVolume.)
	Right	Gets or sets the maximum x-value of the view volume at the near clip plane. (Inherited from ViewVolume.)
	Top	Gets or sets the maximum y-value of the view volume at the near clip plane. (Inherited from ViewVolume.)
	Width	Gets the width of the view volume at the near clip plane. (Inherited from ViewVolume.)

Top

Events

	Name	Description
	Changed	Occurs when the shape was changed. (Inherited from Shape.)

Top

Remarks

A perspective view volume is a frustum. A frustum is a portion of a pyramid that lies between two cutting planes.

The PerspectiveViewVolume class is designed to model the view volume of a perspective camera: The observer is looking from the origin along the negative z-axis. The x-axis points to the right and the y-axis points upwards. Near and Far are positive values that specify the distance from the origin (observer) to the near and far clip planes (Near ≤ Far).

Reference

DigitalRune.Geometry.Shapes Namespace