MeshVertexNormalList

References
public class MeshVertexNormalList : IResizableList<Vector3f>, IList, IReadOnlyList<Vector3f>
Provides access to the Vertex Normals of a Mesh.

Properties

Capacity

#Since v6.0
public int Capacity { get; set; }
Gets or sets the amount of vertex normals that the list can hold without resizing.

Count

#Since v5.0
public int Count { get; set; }
Gets or sets the number of mesh vertex normals.
Implements: Count
Explicit

ICollection<Vector3f>.IsReadOnly

#
bool ICollection<Vector3f>.IsReadOnly
Explicit

ICollection.IsSynchronized

#
bool ICollection.IsSynchronized
Explicit

ICollection.SyncRoot

#
object ICollection.SyncRoot
Explicit

IList.IsFixedSize

#
bool IList.IsFixedSize
Explicit

IList.IsReadOnly

#
bool IList.IsReadOnly

Indexers

Explicit

IList.this[]

#
object IList.this[int index]
Parameters:
index (int)

this[]

#
public Vector3f this[int index] { get; set; }
Gets or sets the vertex at the given index. The index must be valid or an IndexOutOfRangeException will be thrown.
Parameters:
index (int)Index of control vertex to access.
Returns: The control vertex at [index].
Exceptions:
IndexOutOfRangeExceptionThrown when the index is invalid.

Methods

Add

#Since v5.0
public int Add(double x, double y, double z)
Adds a new vertex normal at the end of the list.
Parameters:
x (double)X component of new vertex normal.
y (double)Y component of new vertex normal.
z (double)Z component of new vertex normal.
Returns: The index of the newly added vertex normal.

Add

#Since v5.0
public int Add(float x, float y, float z)
Adds a new vertex normal at the end of the list.
Parameters:
x (float)X component of new vertex normal.
y (float)Y component of new vertex normal.
z (float)Z component of new vertex normal.
Returns: The index of the newly added vertex normal.

Add

#Since v5.0
public int Add(Vector3d normal)
Adds a new vertex normal at the end of the list.
Parameters:
normal (Vector3d)new vertex normal.
Returns: The index of the newly added vertex normal.

Add

#Since v5.0
public int Add(Vector3f normal)
Adds a new vertex normal at the end of the list.
Parameters:
normal (Vector3f)new vertex normal.
Returns: The index of the newly added vertex normal.

AddRange

#Since v5.0
public bool AddRange(Vector3f[] normals)
Appends a collection of normal vectors.
Parameters:
normals (Vector3f[])Normals to append.
Returns: true on success, false on failure.

Clear

#Since v5.0
public void Clear()
Clears the vertex normal collection on the mesh.

ComputeNormals

#ExampleSince v5.0
public bool ComputeNormals()
Computes the vertex normals based on the physical shape of the mesh.
Returns: true on success, false on failure.

Destroy

#Since v6.0
public void Destroy()
Releases all memory allocated to store vertex normals. The list capacity will be 0 after this call.

Subsequent calls can add new items.

Flip

#Since v5.0
public void Flip()
Reverses direction of all vertex normals

This is the same as Mesh.Flip(true, false, false)

GetEnumerator

#Since v5.0
public IEnumerator<Vector3f> GetEnumerator()
Gets an enumerator that yields all normals (vectors) in this collection.
Returns: The enumerator.

SetNormal

#Since v5.0
public bool SetNormal(int index, double x, double y, double z)
Sets or adds a vertex normal to the list.

If [index] is less than [Count], the existing vertex normal at [index] will be modified.

If [index] equals [Count], a new vertex normal is appended to the end of the list.

If [index] is larger than [Count], the function will return false.

Parameters:
index (int)Index of vertex normal to set.
x (double)X component of vertex normal.
y (double)Y component of vertex normal.
z (double)Z component of vertex normal.
Returns: true on success, false on failure.

SetNormal

#Since v5.0
public bool SetNormal(int index, float x, float y, float z)
Sets or adds a normal to the list.

If [index] is less than [Count], the existing vertex normal at [index] will be modified.

If [index] equals [Count], a new vertex normal is appended to the end of the list.

If [index] is larger than [Count], the function will return false.

Parameters:
index (int)Index of vertex normal to set.
x (float)X component of vertex normal.
y (float)Y component of vertex normal.
z (float)Z component of vertex normal.
Returns: true on success, false on failure.

SetNormal

#Since v5.0
public bool SetNormal(int index, Vector3d normal)
Sets or adds a vertex normal to the list.

If [index] is less than [Count], the existing vertex normal at [index] will be modified.

If [index] equals [Count], a new vertex normal is appended to the end of the list.

If [index] is larger than [Count], the function will return false.

Parameters:
index (int)Index of vertex normal to set.
normal (Vector3d)The new normal at the index.
Returns: true on success, false on failure.

SetNormal

#Since v5.0
public bool SetNormal(int index, Vector3f normal)
Sets or adds a vertex normal to the list.

If [index] is less than [Count], the existing vertex normal at [index] will be modified.

If [index] equals [Count], a new vertex normal is appended to the end of the vertex list.

If [index] is larger than [Count], the function will return false.

Parameters:
index (int)Index of vertex normal to set.
normal (Vector3f)The new normal at the index.
Returns: true on success, false on failure.

SetNormals

#Since v5.0
public bool SetNormals(Vector3f[] normals)
Sets all normal vectors in one go. This method destroys the current normal array if it exists.
Parameters:
normals (Vector3f[])Normals for the entire mesh.
Returns: true on success, false on failure.
Explicit

ICollection<Vector3f>.Add

#Since v5.0
void ICollection<Vector3f>.Add(Vector3f item)
Parameters:
item (Vector3f)
Explicit

ICollection<Vector3f>.Contains

#
bool ICollection<Vector3f>.Contains(Vector3f item)
Parameters:
item (Vector3f)
Explicit

ICollection<Vector3f>.CopyTo

#
void ICollection<Vector3f>.CopyTo(Vector3f[] array, int arrayIndex)
Parameters:
array (Vector3f[])
arrayIndex (int)
Explicit

ICollection<Vector3f>.Remove

#
bool ICollection<Vector3f>.Remove(Vector3f item)
Parameters:
item (Vector3f)
Explicit

IList<Vector3f>.IndexOf

#
int IList<Vector3f>.IndexOf(Vector3f item)
Parameters:
item (Vector3f)
Explicit

IList<Vector3f>.Insert

#
void IList<Vector3f>.Insert(int index, Vector3f item)
Parameters:
index (int)
item (Vector3f)
Explicit

IList<Vector3f>.RemoveAt

#
void IList<Vector3f>.RemoveAt(int index)
Parameters:
index (int)
Explicit

ICollection.CopyTo

#
void ICollection.CopyTo(Array array, int index)
Parameters:
array (Array)
index (int)
Explicit

IEnumerable.GetEnumerator

#Since v5.0
IEnumerator IEnumerable.GetEnumerator()
Explicit

IList.Add

#
int IList.Add(object value)
Parameters:
value (object)
Explicit

IList.Contains

#
bool IList.Contains(object value)
Parameters:
value (object)
Explicit

IList.IndexOf

#
int IList.IndexOf(object value)
Parameters:
value (object)
Explicit

IList.Insert

#
void IList.Insert(int index, object value)
Parameters:
index (int)
value (object)
Explicit

IList.Remove

#
void IList.Remove(object value)
Parameters:
value (object)
Explicit

IList.RemoveAt

#
void IList.RemoveAt(int index)
Parameters:
index (int)

ToFloatArray

#Since v6.0
public float[] ToFloatArray()
Copies all vertex normals to a linear array of float in x,y,z order
Returns: The float array.

UnitizeNormals

#Since v5.0
public bool UnitizeNormals()
Unitizes all vertex normals.
Returns: true on success, false on failure.