Provides access to groups in the 3dm file.

Properties

ComponentType

#Since v6.5
public override ModelComponentType ComponentType { get; }

Count

Returns the count of all items, including deleted ones.
public virtual int Count { get; }
inherited fromCommonComponentTable<T>

Methods

Add

Adds an item.
public virtual void Add(
T
item
The item to add.
)
inherited fromFile3dmCommonComponentTable<T>

AddGroup

#Since v8.4
Adds a new empty group to the group table.
public int AddGroup()
>=0 index of new group or -1 on error.

Clear

Marks all items as deleted.
public void Clear()
inherited fromCommonComponentTable<T>

Delete

Flags a component as deleted.
public override bool Delete(
T
item
The item to flag.
)
inherited fromFile3dmCommonComponentTable<T>
True on success.

Delete

Flags a component as deleted.
public virtual void Delete(
index
The index of the item to flag.
)
inherited fromFile3dmCommonComponentTable<T>
True on success.

Dump

Prepares a text dump of object table.
public string Dump()
inherited fromFile3dmCommonComponentTable<T>
A string containing the dump.

FindId

Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.
public virtual T FindId(
id
ID of model component to search for.
)
inherited fromCommonComponentTable<T>
Reference to the rhino object with the objectId or null if no such object could be found.
FindId

FindIndex

#Since v6.5
Retrieves a Group object based on an index. This search type of search is discouraged. We are moving towards using only IDs for all tables.
public Group FindIndex(
groupIndex
The index to search for.
)
A Group object, or null if none was found.

FindName

#Since v6.5
Finds a Group given its name.
public Group FindName(
name
The name of the Group to be searched.
)
A Group, or null on error.

FindNameHash

#Since v6.5
Finds a Group given its name hash.
public Group FindNameHash(
nameHash
The name hash of the Group to be searched.
)
A Group, or null on error.

GetEnumerator

Returns the enumerator that yields all items.
public virtual IEnumerator<T> GetEnumerator()
inherited fromCommonComponentTable<T>

GroupMembers

#Since v6.20
Gets an array of all of the objects in a group.
public File3dmObject[] GroupMembers(
groupIndex
The index of the group in this table.
)
Array of objects that belong to the specified group or empty array if no objects could be found.