essentials.action.Pathing.Rails.StepRail Class Reference

Slightly difference from an AbstractRail, this doesn't keep track of interpolation, but just the list of ordered points to traverse More...

Inheritance diagram for essentials.action.Pathing.Rails.StepRail:

Public Member Functions
	StepRail (IEnumerable< Vector3d > path)
	StepRail (Path path, Vector3d offset)
	StepRail (Path path)
bool	Advance ()
IEnumerator< Vector3d >	GetEnumerator ()

Static Public Member Functions
static StepRail	FromPathSmoothedXY (Path path, float centerWeight=1f)

Properties
int	Index [get, set]
	Current (clamped) index More...
int	Length [get]
Vector3d	Position [get]
Vector3d	LookDirection [get]

Detailed Description

Slightly difference from an AbstractRail, this doesn't keep track of interpolation, but just the list of ordered points to traverse

Constructor & Destructor Documentation

StepRail() [1/3]

essentials.action.Pathing.Rails.StepRail.StepRail

(

IEnumerable< Vector3d >

path

)

        {
            _rail = path.ToArray();
        }

StepRail() [2/3]

essentials.action.Pathing.Rails.StepRail.StepRail	(	Path	path,
		Vector3d	offset
	)

            :this(path.Select(x => x + offset))
        {}

StepRail() [3/3]

essentials.action.Pathing.Rails.StepRail.StepRail

(

Path

path

)

            :this(path, Vector3d.Zero)
        {}

Member Function Documentation

Advance()

bool essentials.action.Pathing.Rails.StepRail.Advance

(

)

        {
            if (_idx >= _rail.Length-1)
            {
                return false;
            }
            this.Index++;
            return true;
        }

FromPathSmoothedXY()

static StepRail essentials.action.Pathing.Rails.StepRail.FromPathSmoothedXY ( Path  path, float  centerWeight = 1f  )

static

Attribute: path.Count

;

Attribute: 0] = path[0

+ CENTERXY;

Attribute: path.Count - 1] = path[path.Count - 1

+ CENTERXY;

Attribute: i

= (

Attribute: i

+ CENTERXY) * centerWeight

Attribute: i - 1

+ CENTERXY)

Attribute: i + 1

) + CENTERXY)

        {
            Vector3d CENTERXY = new Vector3d(0.5, 0.5, 0);

            var pts = new Vector3d[path.Count];
            pts[0] = path[0] + CENTERXY;
            pts[path.Count - 1] = path[path.Count - 1] + CENTERXY;

            for (int i = 1; i < path.Count - 1; i++)
            {
                pts[i] = (
                    (path[i] + CENTERXY) * centerWeight
                    + (path[i - 1] + CENTERXY)
                    + (path[i + 1]) + CENTERXY)
                    / (2 + centerWeight);
            }

            return new StepRail(pts);
        }

GetEnumerator()

IEnumerator<Vector3d> essentials.action.Pathing.Rails.StepRail.GetEnumerator

(

)

        {
            return ((IEnumerable<Vector3d>)_rail).GetEnumerator();
        }

Property Documentation

Index

int essentials.action.Pathing.Rails.StepRail.Index

getset

Current (clamped) index

The index.

Length

int essentials.action.Pathing.Rails.StepRail.Length

get

LookDirection

Vector3d essentials.action.Pathing.Rails.StepRail.LookDirection

get

Position

Vector3d essentials.action.Pathing.Rails.StepRail.Position

get

---

The documentation for this class was generated from the following file:

• essentials.action/Pathing/Rails/StepRail.cs