File3dmNamedConstructionPlanes

References
public class File3dmNamedConstructionPlanes : IList<ConstructionPlane>
Provides access to named construction planes in the 3dm file.

Properties

Count

#Since v6.0
public int Count { get; }
Number of named construction planes in the table.

Indexers

Explicit

IList<ConstructionPlane>.this[]

#
ConstructionPlane IList<ConstructionPlane>.this[int index]
Parameters:
index (int)

this[]

#
public ConstructionPlane this[int index] { get; }
Gets the named construction plane at an index.
Parameters:
index (int)Zero based array index.
Returns: A construction plane at the index, or null on error.

Methods

Add

#Since v6.0
public int Add(string name, Plane plane)
Adds a named construction plane to the table.
Parameters:
name (string)The name of the named construction plane.
plane (Plane)The plane value.
Returns: 0 based index of the named construction plane. -1 on failure.

Add

#Since v6.0
public void Add(ConstructionPlane cplane)
Adds a named construction plane to the table.
Parameters:
cplane (ConstructionPlane)The construction plane to add.

Clear

#Since v6.0
public void Clear()
Removes all named construction planes from the table.

Contains

#Since v6.0
public bool Contains(ConstructionPlane cplane)
Returns an indication of the presence of a named construction plane in the table.
Parameters:
cplane (ConstructionPlane)The construction plane to check.
Returns: true if the named construction plane is in the table; false otherwise.

CopyTo

#Since v6.0
public void CopyTo(ConstructionPlane[] array, int arrayIndex)
Copies the content of the table to an array.
Parameters:
array (ConstructionPlane[])
arrayIndex (int)

Delete

#Since v6.0
public bool Delete(ConstructionPlane cplane)
Deletes a named construction plane from the table.
Parameters:
cplane (ConstructionPlane)The construction plane to delete.

Delete

#Since v6.0
public bool Delete(int index)
Remove a named construction plane from the table.
Parameters:
index (int)Zero based array index.
Returns: true if successful.

FindName

#Since v6.0
public ConstructionPlane FindName(string name)
Finds a named construction plane given its name.
Parameters:
name (string)The name of the construction plane to be searched.
Returns: A ConstructionPlane, or null if not found.

GetEnumerator

#Since v6.0
public IEnumerator<ConstructionPlane> GetEnumerator()
Gets an enumerator that yields all construction planes in this collection.
Returns: The enumerator.

IndexOf

#Since v6.0
public int IndexOf(ConstructionPlane cplane)
Returns the index of a named construction plane.
Parameters:
cplane (ConstructionPlane)The construction plane to be searched.
Returns: The index of the named construction plane, -1 if not found.
Explicit

IList<ConstructionPlane>.Insert

#
void IList<ConstructionPlane>.Insert(int index, ConstructionPlane cplane)
Parameters:
index (int)
cplane (ConstructionPlane)
Explicit

IList<ConstructionPlane>.RemoveAt

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

IEnumerable.GetEnumerator

#Since v6.0
IEnumerator IEnumerable.GetEnumerator()