NamedPositionTable

References
public sealed class NamedPositionTable
All named positions in a rhino document.

Properties

Count

#Since v6.0
Number of Named Positions in the table.
public int Count { get; }

Document

#Since v6.0
Document that owns this table.
public RhinoDoc Document { get; }

Ids

#Since v6.0
Array of Named Position Guids.
public Guid[] Ids { get; }
Guid array of each Named Position in the document.

Names

#Since v6.0
Array of Named Position names.
public string[] Names { get; }
A string array with the names all Named Positions in the document.

Methods

Append

#Since v6.0
Append objects to a Named Position.
public bool Append(
id,
Guid of the Named Position which you want to append to.
objectIds
New object ids to be included in this Named Position.
)
True or False depending on whether the Append was successful.

Append

#Since v6.0
Append objects to a Named Position.
public bool Append(
id,
Guid of the Named Position which you want to append to.
objects
Collection of Rhino Objects to be included in this Named Position.
)
True or False depending on whether the Append was successful.

Append

#Since v6.0
Append objects to a Named Position.
public bool Append(
name,
Name of the Named Position which you want to append to.
objectIds
New object Guids to be included in this Named Position.
)
True or False depending on whether the Append was successful.

Append

#Since v6.0
Append objects to a Named Position.
public bool Append(
name,
Name of the Named Position which you want to append to.
objects
Collection of Rhino Objects to be included in this Named Position.
)
True or False depending on whether the Append was successful.

Delete

#Since v6.0
Delete a Named Position.
public bool Delete(
id
Guid of the Named Position which you want to delete.
)
True or False depending on whether the Delete was successful, Null in case the id does not exist as a Named Position.

Delete

#Since v6.0
Delete a Named Position.
public bool Delete(
name
Name of the Named Position which you want to delete.
)
True or False depending on whether the Delete was successful, Null in case the id does not exist as a Named Position.

Id

#Since v6.0
Guid of a Named Position.
public Guid Id(
name
Name of the Named Position for which you want to retrieve the Guid.
)
The Guid of the Named Position. If not found, an empty Guid is returned.

Name

#Since v6.0
Name of a Named Position.
public string Name(
id
Guid of the Named Position for which you want to retrieve the name.
)
The name of the Named Position as a string.

ObjectIds

#Since v6.0
Array of Rhino Object Guids related to a Named Position.
public Guid[] ObjectIds(
id
The Guid of the named position from which you want to retrieve the objects.
)
Array of Guid which pertain to the objects tracked by the Named Position.

ObjectIds

#Since v6.0
Array of Rhino Object Guids related to a Named Position.
public Guid[] ObjectIds(
name
The name of the Named Position from which you want to retrieve the objects.
)
Array of Guid which pertain to the objects tracked by the Named Position, or null in case no such Named Position is found.

Objects

#Since v6.0
Array of Rhino Objects related to a Named Position.
public RhinoObject[] Objects(
id
The Guid of the named position from which you want to retrieve the objects.
)
Array of Rhino Objects which are tracked by the Named Position.

Objects

#Since v6.0
Array of Rhino Objects related to a Named Position.
public RhinoObject[] Objects(
name
The name of the Named Position from which you want to retrieve the objects.
)
Array of Rhino Objects which are tracked by the Named Position if successful, null if no such Named Position exists.

ObjectXform

#Since v6.0
Retrieve the Transform of a Rhino Object relate to a Named Position.
public bool ObjectXform(
id,
The Guid of the Named Position
objId,
The Guid of the Rhino Object from which to retrieve the Transform.
xform
The Transform to retrieve.
)
Transform of the RhinoObject related to the Named Position.

ObjectXform

#Since v6.0
Retrieve the Transform of a Rhino Object relate to a Named Position.
public bool ObjectXform(
id,
The Guid of the Named Position
obj,
The Rhino Object from which to retrieve the Transform.
xform
The Transform to retrieve.
)
Transform of the RhinoObject related to the Named Position.

Rename

#Since v6.0
Rename a Named Position.
public bool Rename(
id,
Guid of the Named Position which you want to rename.
name
New name for the Named Position.
)
True or False depending on whether the Rename was successful. For example, this method might return False if you attempt to rename the Named Position with the currently assigned name.

Rename

#Since v6.0
Rename a Named Position.
public bool Rename(
oldName,
Current name of the Named Position which you want to rename.
name
New name for the Named Position.
)
True or False depending on whether the Rename was successful. For example, this method might return False if you attempt to rename the Named Position with the currently assigned name.

Restore

#Since v6.0
Restore a Named Position.
public bool Restore(
id
Guid of the Named Position to restore.
)
True or False based on whether the Named Position was able to be restored.

Restore

#Since v6.0
Restore a Named Position.
public bool Restore(
name
Name of the Named Position to restore.
)
True or False based on whether the Named Position was able to be restored.

Save

#Since v6.0
Save a new Named Position.
public Guid Save(
name,
Name for this Named Position.
objectIds
Array of Rhino Object Ids which should be included in this Named Position.
)
Guid of the newly saved Named Position.

Save

#Since v6.0
Save a new Named Position.
public Guid Save(
name,
Name for this Named Position.
objects
Array of Rhino Objects which should be included in this Named Position.
)
Guid of the newly saved Named Position.

Update

#Since v6.0
Updates a Named Position, effectively storing the current positions of the objects which the Named Position is tracking.
public bool Update(
id
Guid of the Named Position which you want to update.
)
True or False depending on whether the Update was successful.

Update

#Since v6.0
Updates a Named Position, effectively storing the current positions of the objects which the Named Position is tracking.
public bool Update(
name
Name of the Named Position which you want to update.
)
True or False depending on whether the Update was successful.