NamedPositionTable

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

Properties

Count

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

Document

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

Ids

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

Names

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

Methods

Append

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

Append

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

Append

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

Append

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

Delete

#Since v6.0
public bool Delete(Guid id)
Delete a Named Position.
Parameters:
id (Guid)Guid of the Named Position which you want to delete.
Returns: 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
public bool Delete(string name)
Delete a Named Position.
Parameters:
name (string)Name of the Named Position which you want to delete.
Returns: 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
public Guid Id(string name)
Guid of a Named Position.
Parameters:
name (string)Name of the Named Position for which you want to retrieve the Guid.
Returns: The Guid of the Named Position. If not found, an empty Guid is returned.

Name

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

ObjectIds

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

ObjectIds

#Since v6.0
public Guid[] ObjectIds(string name)
Array of Rhino Object Guids related to a Named Position.
Parameters:
name (string)The name of the Named Position from which you want to retrieve the objects.
Returns: 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
public RhinoObject[] Objects(Guid id)
Array of Rhino Objects related to a Named Position.
Parameters:
id (Guid)The Guid of the named position from which you want to retrieve the objects.
Returns: Array of Rhino Objects which are tracked by the Named Position.

Objects

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

ObjectXform

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

ObjectXform

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

Rename

#Since v6.0
public bool Rename(Guid id, string name)
Rename a Named Position.
Parameters:
id (Guid)Guid of the Named Position which you want to rename.
name (string)New name for the Named Position.
Returns: 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
public bool Rename(string oldName, string name)
Rename a Named Position.
Parameters:
oldName (string)Current name of the Named Position which you want to rename.
name (string)New name for the Named Position.
Returns: 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
public bool Restore(Guid id)
Restore a Named Position.
Parameters:
id (Guid)Guid of the Named Position to restore.
Returns: True or False based on whether the Named Position was able to be restored.

Restore

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

Save

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

Save

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

Update

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

Update

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