• Articles
  • Api Documentation
Show / Hide Table of Contents
  • AlchemyBow.Navigation
    • AlchemyNavigationSystem
    • BasicAgent
    • FacesHolder
    • NavigationAct
    • NavigationFaceWrapper
    • NavigationInfo
    • PathfindingRequest
    • PathfindingRequest.PathType
    • PathfindingRequest.Status
  • AlchemyBow.Navigation.BackgroundProcessing
    • BackgroundProcessor
    • BackgroundProcessor.States
    • BuildingProcess
    • IBackgroundCommand
    • PathfindingProcess
    • RegisterFaceCommand
    • UnregisterFaceCommand
  • AlchemyBow.Navigation.Collections
    • OrderedSet<T>
    • OrderedSetNode<T>
    • OrderedSetRangeComparer<T>
  • AlchemyBow.Navigation.DebugUnits
    • AlchemyNavigationSystemDebugUnit
    • CompositeSurfaceDrawer
    • GizmosSurfaceDrawer
    • ISurfaceDrawer
    • MinimalGizmosSurfaceDrawer
  • AlchemyBow.Navigation.HighLevel
    • MeshBasedBake
    • MeshBasedBakeGroup
    • MeshBasedBakeSettings
    • WorldMesh
  • AlchemyBow.Navigation.PropertyAttributes
    • AreaIndexAttribute
    • AreaMaskAttribute
    • LayerIndexAttribute
  • AlchemyBow.Navigation.Settings
    • AlchemyNavigationSettingsPreset
    • NavigationAreaSettings
    • NavigationLayerSettings
    • NavigationSettings
  • AlchemyBow.Navigation.Simple
    • SimpleAgent
  • AlchemyBow.Navigation.Simple.Elements
    • AvoidanceGroup
    • AvoidanceModifier
    • CachedFace
    • ISteeredBehaviour
    • MovementModifier
    • PathProgress
  • AlchemyBow.Navigation.Surfaces
    • Edge
    • Face
    • FacesByMagnitudeRangeComparer
    • NavigationSurface
    • SurfaceRaycastHit
    • Usage<TUser>
    • UsageTrackingObject<TUser>
    • Vertex
    • VertexByPositionComparer
  • AlchemyBow.Navigation.Surfaces.SafeAccess
    • IImmutableFace
    • SurfaceImmutableRaycastHit
  • AlchemyBow.Navigation.Utilities
    • ChannelUnwrapper
    • FaceAStar
    • FaceStarUnit
    • Funnel
    • ICommand

Class CachedFace

Caches the face and provides additional vector math methods.

Inheritance
System.Object
CachedFace
Namespace: AlchemyBow.Navigation.Simple.Elements
Assembly: AlchemyBow.Navigation.dll
Syntax
public sealed class CachedFace

Constructors

| Improve this Doc View Source

CachedFace(IImmutableFace)

Creates an instance of the CachedFace class.

Declaration
public CachedFace(IImmutableFace source)
Parameters
Type Name Description
IImmutableFace source

The source face.

Fields

| Improve this Doc View Source

a

The cached A vertex value of the source face.

Declaration
public readonly Vector3 a
Field Value
Type Description
UnityEngine.Vector3

The cached A vertex value of the source face.

| Improve this Doc View Source

b

The cached B vertex value of the source face.

Declaration
public readonly Vector3 b
Field Value
Type Description
UnityEngine.Vector3

The cached B vertex value of the source face.

| Improve this Doc View Source

c

The cached C vertex value of the source face.

Declaration
public readonly Vector3 c
Field Value
Type Description
UnityEngine.Vector3

The cached C vertex value of the source face.

| Improve this Doc View Source

plane

The cached plane of the source face.

Declaration
public readonly Plane plane
Field Value
Type Description
UnityEngine.Plane

The cached plane of the source face.

| Improve this Doc View Source

source

The source face.

Declaration
public readonly IImmutableFace source
Field Value
Type Description
IImmutableFace

The source face.

Methods

| Improve this Doc View Source

CastDisplacementOnClosestEdge(Vector3, Vector3)

Casts displacement on the closest edge of the face.

Declaration
public Vector3 CastDisplacementOnClosestEdge(Vector3 current, Vector3 displacement)
Parameters
Type Name Description
UnityEngine.Vector3 current

The current position.

UnityEngine.Vector3 displacement

The displacement.

Returns
Type Description
UnityEngine.Vector3

The casted displacement.

| Improve this Doc View Source

SnapToFace(Vector3, Vector3)

Snaps the result of the displacement to the face.

Declaration
public Vector3 SnapToFace(Vector3 current, Vector3 displacement)
Parameters
Type Name Description
UnityEngine.Vector3 current

The current position.

UnityEngine.Vector3 displacement

The displacement.

Returns
Type Description
UnityEngine.Vector3

The snapped displacement result.

Remarks

The current must be inside the face, and displacement must point outside.

  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX