struct Plane

in global :: Sandbox

Represents a plane.

public Vector3 Normal

The direction of the plane.

public float Distance

Distance of the plane from world origin in the direction given by .

public Plane( ref Vector3 origin, ref Vector3 posA, ref Vector3 posB )

Creates a new plane from 3 given positions.

  • origin Origin of the plane.
  • posA A position to calculate a normal with.
  • posB Another position to calculate a normal with.

public Vector3 Origin { get; }

Origin position of the plane, basically a vector away from world origin in the direction given by .

public Vector3 Position { get; }

Origin position of the plane, basically a vector away from world origin in the direction given by .

public float GetDistance( ref Vector3 point )

Returns the distance from this plane to given point.

public bool IsInFront( Vector3 point )

Returns true if given point is on the side of the plane where its normal is pointing.

public bool IsInFront( BBox box, bool partially = False )

Returns true if given bounding box is on the side of the plane where its normal is pointing.

public Vector3 SnapToPlane( ref Vector3 point )

Returns closest point on the plane to given point.

public bool TryTrace( ref Ray ray, ref Vector3 hitPoint, bool twosided = False, double maxDistance = 1.7976931348623157E+308 )

Trace a Ray against this plane

public Nullable<Vector3> Trace( ref Ray ray, bool twosided = False, double maxDistance = 1.7976931348623157E+308 )

Trace a Ray against this plane

  • ray The origin and direction to trace from
  • twosided If true we'll trace against the underside of the plane too.
  • maxDistance The maximum distance from the ray origin to trace
  • Returns The hit position on the ray. Or null if we didn't hit.

public static Nullable<Vector3> GetIntersection( ref Plane vp1, ref Plane vp2, ref Plane vp3 )

Gets the intersecting point of the three planes if it exists. If the planes don't all intersect will return null.

public Nullable<Vector3> IntersectLine( Line line )

Gets the intersecting point of a line segment.

public Nullable<Vector3> IntersectLine( Vector3 start, Vector3 end )

Gets the intersecting point of a line segment.

public Plane( ref Vector3 origin, ref Vector3 normal )

😔 No documentation found.

public Plane( ref Vector3 normal, ref float dist )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public static bool op_Equality( Plane left, Plane right )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public bool Equals( Plane o )

😔 No documentation found.

public static bool op_Inequality( Plane left, Plane right )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.