Plane Structure

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Defines a plane.

Namespace:  Microsoft.Xna.Framework
Assembly:  Microsoft.Xna.Framework.Math (in Microsoft.Xna.Framework.Math.dll)

Syntax

'Declaration
Public Structure Plane
public struct Plane

The Plane type exposes the following members.

Constructors

  Name Description
Public method Plane(Vector4) Creates a new instance of Plane.
Public method Plane(Vector3, Single) Creates a new instance of Plane.
Public method Plane(Vector3, Vector3, Vector3) Creates a new instance of Plane.
Public method Plane(Single, Single, Single, Single) Creates a new instance of Plane.

Top

Methods

  Name Description
Public method Dot(Vector4) Calculates the dot product of a specified Vector4 and this Plane.
Public method Dot(Vector4%, Single%) Calculates the dot product of a specified Vector4 and this Plane.
Public method DotCoordinate(Vector3) Returns the dot product of a specified Vector3 and the Normal vector of this Plane plus the distance (D) value of the Plane.
Public method DotCoordinate(Vector3%, Single%) Returns the dot product of a specified Vector3 and the Normal vector of this Plane plus the distance (D) value of the Plane.
Public method DotNormal(Vector3) Returns the dot product of a specified Vector3 and the Normal vector of this Plane.
Public method DotNormal(Vector3%, Single%) Returns the dot product of a specified Vector3 and the Normal vector of this Plane.
Public method Equals(Object) Determines whether the specified Object is equal to the Plane. (Overrides ValueType.Equals(Object).)
Public method Equals(Plane) Determines whether the specified Plane is equal to the Plane.
Public method GetHashCode Gets the hash code for this object. (Overrides ValueType.GetHashCode().)
Public method Intersects(BoundingBox) Checks whether the current Plane intersects a specified BoundingBox.
Public method Intersects(BoundingFrustum) Checks whether the current Plane intersects a specified BoundingFrustum.
Public method Intersects(BoundingSphere) Checks whether the current Plane intersects a specified BoundingSphere.
Public method Intersects(BoundingBox%, PlaneIntersectionType%) Checks whether the current Plane intersects a BoundingBox.
Public method Intersects(BoundingSphere%, PlaneIntersectionType%) Checks whether the current Plane intersects a BoundingSphere.
Public method Normalize() Changes the coefficients of the Normal vector of this Plane to make it of unit length.
Public methodStatic member Normalize(Plane) Changes the coefficients of the Normal vector of a Plane to make it of unit length.
Public methodStatic member Normalize(Plane%, Plane%) Changes the coefficients of the Normal vector of a Plane to make it of unit length.
Public method ToString Returns a String that represents the current Plane. (Overrides ValueType.ToString().)
Public methodStatic member Transform(Plane, Matrix) Transforms a normalized Plane by a Matrix.
Public methodStatic member Transform(Plane, Quaternion) Transforms a normalized Plane by a Quaternion rotation.
Public methodStatic member Transform(Plane%, Matrix%, Plane%) Transforms a normalized Plane by a Matrix.
Public methodStatic member Transform(Plane%, Quaternion%, Plane%) Transforms a normalized Plane by a Quaternion rotation.

Top

Operators

  Name Description
Public operatorStatic member Equality Determines whether two instances of Plane are equal.
Public operatorStatic member Inequality Determines whether two instances of Plane are not equal.

Top

Fields

  Name Description
Public field D The distance of the Plane along its normal from the origin.
Public field Normal The normal vector of the Plane.

Top

Remarks

The Plane structure represents a plane using a 3D vector normal and a distance value (stored as a negative value).

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.