File3dmGroupTable

File3dmCommonComponentTable<1>CommonComponentTable<1>References
public class File3dmGroupTable : File3dmCommonComponentTable<Group>, IList<Group>
Provides access to groups in the 3dm file.

Properties

ComponentType

#Since v6.5
public override ModelComponentType ComponentType { get; }
Returns ModelComponentType.Group.
Overrides: CommonComponentTable<T>.ComponentType

Count

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

Methods

Add

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

AddGroup

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

Clear

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

Delete

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

Delete

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

Dump

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

FindId

public virtual T FindId(Guid id)
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.
inherited fromCommonComponentTable<T>
Parameters:
id (Guid)ID of model component to search for.
Returns: Reference to the rhino object with the objectId or null if no such object could be found.
Implements: FindId

FindIndex

#Since v6.5
public Group FindIndex(int groupIndex)
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.
Parameters:
groupIndex (int)The index to search for.
Returns: A Group object, or null if none was found.

FindName

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

FindNameHash

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

GetEnumerator

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

GroupMembers

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