NamedConstructionPlaneTable

References
public sealed class NamedConstructionPlaneTable : IEnumerable<ConstructionPlane>
Contains all named construction planes in a rhino document.

This class cannot be inherited.

Properties

Count

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

Document

#Since v5.0
public RhinoDoc Document { get; }
Gets the document that owns this table.

Indexers

this[]

#
public ConstructionPlane this[int index] { get; }
Conceptually, the named construction plane table is an array of ConstructionPlanes and their associated names. The operator[] can be used to get individual ConstructionPlanes.
Parameters:
index (int)Zero based array index.
Returns: A construction plane at the index, or null on error.

Methods

Add

#Since v8.18
public int Add(ConstructionPlane constructionPlane)
Adds named construction plane to document.
Parameters:
constructionPlane (ConstructionPlane)The construction plane value.
Returns: 0 based index of named construction plane. -1 on failure.

Add

#Since v5.0
public int Add(string name, Plane plane)
Adds named construction plane to document.
Parameters:
name (string)If name is empty, a unique name is automatically created. If there is already a named construction plane with the same name, that construction plane is replaced.
plane (Plane)The plane value.
Returns: 0 based index of named construction plane. -1 on failure.

Delete

#Since v5.0
public bool Delete(int index)
Remove named construction plane from the document.
Parameters:
index (int)zero based array index.
Returns: true if successful.

Delete

#Since v5.0
public bool Delete(string name)
Remove named construction plane from the document.
Parameters:
name (string)name of the construction plane.
Returns: true if successful.

Find

#Since v5.0
public int Find(string name)
Finds a named construction plane.
Parameters:
name (string)Name of construction plane to search for.
Returns: >=0 index of the construction plane with the given name. -1 no construction plane found with the given name.

GetEnumerator

#Since v5.0
public IEnumerator<ConstructionPlane> GetEnumerator()
Explicit

IEnumerable.GetEnumerator

#Since v5.0
IEnumerator IEnumerable.GetEnumerator()