Class BoneBuilder

Namespace

ReFuel.Resources

Assembly

ReFuel.dll

A node in an ArmatureBuilder bone tree.

public class BoneBuilder : IList<BoneBuilder>, ICollection<BoneBuilder>, IEnumerable<BoneBuilder>, IEnumerable

Inheritance

object

BoneBuilder

Implements

IList<BoneBuilder>

ICollection<BoneBuilder>

IEnumerable<BoneBuilder>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BoneBuilder()

Create an empty bone.

public BoneBuilder()

BoneBuilder(Vector3, Vector3)

Create an empty bone.

public BoneBuilder(Vector3 head, Vector3 tail)

Parameters

head Vector3

The head vector.

tail Vector3

The tail vector.

BoneBuilder(Vector3, Vector3, IEnumerable<BoneBuilder>)

Create an empty bone.

public BoneBuilder(Vector3 head, Vector3 tail, IEnumerable<BoneBuilder> children)

Parameters

head Vector3

The head vector.

tail Vector3

The tail vector.

children IEnumerable<BoneBuilder>

The children of this bone.

BoneBuilder(IEnumerable<BoneBuilder>)

Create an empty bone.

public BoneBuilder(IEnumerable<BoneBuilder> children)

Parameters

children IEnumerable<BoneBuilder>

Properties

Children

Children of this bone.

public List<BoneBuilder> Children { get; }

Property Value

List<BoneBuilder>

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

Head

The bone head vector, relative to the parent tail.

public Vector3 Head { get; set; }

Property Value

Vector3

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

this[int]

Gets or sets the element at the specified index.

public BoneBuilder this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

BoneBuilder

The element at the specified index.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The property is set and the IList<T> is read-only.

Parent

Parent bone.

public BoneBuilder? Parent { get; }

Property Value

BoneBuilder

Tail

The bone tail pointer, relative to the parent tail.

public Vector3 Tail { get; set; }

Property Value

Vector3

Methods

Add(BoneBuilder)

Adds an item to the ICollection<T>.

public void Add(BoneBuilder item)

Parameters

item BoneBuilder

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(BoneBuilder)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(BoneBuilder item)

Parameters

item BoneBuilder

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(BoneBuilder[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(BoneBuilder[] array, int arrayIndex)

Parameters

array BoneBuilder[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

CreateChild()

Create an empty bone as a child.

public BoneBuilder CreateChild()

Returns

BoneBuilder

The child bone.

CreateChild(Vector3, Vector3)

Create an empty bone as a child.

public BoneBuilder CreateChild(Vector3 head, Vector3 tail)

Parameters

head Vector3

The head vector.

tail Vector3

The tail vector.

Returns

BoneBuilder

The child bone.

CreateChild<T>(Vector3, Vector3, T)

Create a bone, with children, as a child.

public BoneBuilder CreateChild<T>(Vector3 head, Vector3 tail, T children) where T : IEnumerable<BoneBuilder>

Parameters

head Vector3

The head vector.

tail Vector3

The tail vector.

children T

The bone children.

Returns

BoneBuilder

The child bone.

Type Parameters

T

CreateChild<T>(T)

Create a bone, with children, as a child.

public BoneBuilder CreateChild<T>(T children) where T : IEnumerable<BoneBuilder>

Parameters

children T

The children of the created bone.

Returns

BoneBuilder

The child bone.

Type Parameters

T

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<BoneBuilder> GetEnumerator()

Returns

IEnumerator<BoneBuilder>

An enumerator that can be used to iterate through the collection.

IndexOf(BoneBuilder)

Determines the index of a specific item in the IList<T>.

public int IndexOf(BoneBuilder item)

Parameters

item BoneBuilder

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

Insert(int, BoneBuilder)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, BoneBuilder item)

Parameters

index int

The zero-based index at which item should be inserted.

item BoneBuilder

The object to insert into the IList<T>.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Remove(BoneBuilder)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(BoneBuilder item)

Parameters

item BoneBuilder

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

RemoveAt(int)

Removes the IList<T> item at the specified index.

public void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.