Interface IImmutableFace

Threadsafe inteterface for the Face class.

Namespace: AlchemyBow.Navigation.Surfaces.SafeAccess

Assembly: AlchemyBow.Navigation.dll

Syntax

public interface IImmutableFace

Properties

A

Gets the first vertex of the face.

Declaration

Vector3 A { get; }

Property Value

Type	Description
UnityEngine.Vector3	The first vertex of the face.

AreaMask

Gets the index of the area to witch the face belongs, as a mask.

Declaration

int AreaMask { get; }

Property Value

Type	Description
System.Int32	The index of the area to witch the face belongs, as a mask.

B

Gets the second vertex of the face.

Declaration

Vector3 B { get; }

Property Value

Type	Description
UnityEngine.Vector3	The second vertex of the face.

C

Gets the third vertex of the face.

Declaration

Vector3 C { get; }

Property Value

Type	Description
UnityEngine.Vector3	The third vertex of the face.

Plane

Gets the plane of the face.

Declaration

Plane Plane { get; }

Property Value

Type	Description
UnityEngine.Plane	The plane of the face.

Weight

Gets the weight of the face.

Declaration

float Weight { get; }

Property Value

Type	Description
System.Single	The weight of the face.

Methods

IsPointInsideFace(Vector3, Single)

Determines whether an point is on the face.

Declaration

bool IsPointInsideFace(Vector3 point, float offset = 0F)

Parameters

Type	Name	Description
UnityEngine.Vector3	point	The point to check.
System.Single	offset	Calculation offset. (optional)

Returns

Type	Description
System.Boolean	true if the is on the face; otherwise, false.

Raycast(Ray, out Single)

Raycasts the face.

Declaration

bool Raycast(Ray ray, out float distance)

Parameters

Type	Name	Description
UnityEngine.Ray	ray	The starting point and direction of the ray.
System.Single	distance	If true is returned, distance will be the signed distance to the intersection point.

Returns

Type	Description
System.Boolean	true if the ray intersects with the face; otherwise, false.