Do a pass on the documentation:
- Add and update inline documentation. - Mark some inconsistencies. - Not everything is reviewed yet.
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
using System;
|
||||
using UnityEngine;
|
||||
|
||||
// ReSharper disable once CheckNamespace
|
||||
@@ -22,22 +23,38 @@ namespace AnimatorAsCode.V1
|
||||
AnimatorRoot = animatorRoot;
|
||||
}
|
||||
|
||||
/// Move the node the left of the other node in the graph.
|
||||
public TNode LeftOf(AacAnimatorNode otherNode) => MoveNextTo(otherNode, -1, 0);
|
||||
|
||||
/// Move the node the right of the other node in the graph.
|
||||
public TNode RightOf(AacAnimatorNode otherNode) => MoveNextTo(otherNode, 1, 0);
|
||||
|
||||
/// Move the node to be over the other node in the graph.
|
||||
public TNode Over(AacAnimatorNode otherNode) => MoveNextTo(otherNode, 0, -1);
|
||||
|
||||
/// Move the node to be under the other node in the graph.
|
||||
public TNode Under(AacAnimatorNode otherNode) => MoveNextTo(otherNode, 0, 1);
|
||||
|
||||
/// Move the node to the left of the last created node of the state machine this belongs to in the graph.
|
||||
public TNode LeftOf() => MoveNextTo(null, -1, 0);
|
||||
|
||||
/// Move the node to the right of the last created node of the state machine this belongs to in the graph.
|
||||
public TNode RightOf() => MoveNextTo(null, 1, 0);
|
||||
|
||||
/// Move the node to be over the last created node of the state machine this belongs to in the graph.
|
||||
public TNode Over() => MoveNextTo(null, 0, -1);
|
||||
|
||||
/// Move the node to be under the last created node of the state machine this belongs to in the graph.
|
||||
public TNode Under() => MoveNextTo(null, 0, 1);
|
||||
|
||||
/// Move the node to be at a specific position in grid units, where x positive goes right, and y positive goes down.
|
||||
public TNode At(int x, int y)
|
||||
{
|
||||
SetPosition(new Vector3(x * DefaultsProvider.Grid().x, y * DefaultsProvider.Grid().y, 0));
|
||||
return (TNode) this;
|
||||
}
|
||||
|
||||
/// Move the state to be shifted next to the other state in the graph, in grid units. shiftX positive goes right, shiftY positive goes down.
|
||||
public TNode Shift(AacAnimatorNode otherState, int shiftX, int shiftY) => MoveNextTo(otherState, shiftX, shiftY);
|
||||
|
||||
private TNode MoveNextTo(AacAnimatorNode otherStateOrSecondToLastWhenNull, int x, int y)
|
||||
@@ -55,20 +72,25 @@ namespace AnimatorAsCode.V1
|
||||
|
||||
return (TNode) this;
|
||||
}
|
||||
|
||||
|
||||
// FIXME API: Vector3 is really odd as a type.
|
||||
/// Given another position in non-grid units, move the state to be shifted next to that position, in grid units. shiftX positive goes right, shiftY positive goes down.
|
||||
public TNode Shift(Vector3 otherPosition, int shiftX, int shiftY)
|
||||
{
|
||||
SetPosition(otherPosition + new Vector3(shiftX * DefaultsProvider.Grid().x, shiftY * DefaultsProvider.Grid().y, 0));
|
||||
return (TNode) this;
|
||||
}
|
||||
|
||||
/// Resolve the path of an item relative to the AnimatorRoot.
|
||||
public string ResolveRelativePath(Transform item)
|
||||
{
|
||||
return AacInternals.ResolveRelativePath(AnimatorRoot, item);
|
||||
}
|
||||
|
||||
/// Create a behaviour of the given type if it doesn't exist, or returns the first behaviour of that type.
|
||||
public abstract TBehaviour EnsureBehaviour<TBehaviour>() where TBehaviour : StateMachineBehaviour;
|
||||
|
||||
/// Create a behaviour of the given type.
|
||||
public abstract TBehaviour CreateNewBehaviour<TBehaviour>() where TBehaviour : StateMachineBehaviour;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user