InstanceDefinitionTable

InstanceDefinitionTable class

Inheritence: Rhino.FileIO.CommonComponentTable<T>RhinoDocCommonTable<InstanceDefinition>InstanceDefinitionTable
Derived Classes:

Namespace: Rhino.DocObjects.Tables
InstanceDefinitionTable: references

Properties (8)

ActiveCount

Number of items in the instance definitions table, excluding deleted definitions.

ComponentType

Returns the actual component type of a table.

Count

Number of items in the instance definitions table.

Count

Returns the count of all items, including deleted ones.

Document

Document that owns this table.

Document

Document that owns this table.

Item

Conceptually, the InstanceDefinition table is an array of Instance definitions. The operator[] can be used to get individual instance definition. An instance definition is either active or deleted and this state is reported by IsDeleted or will be None if it has been purged from the document.

Methods (37)

Add(string name, string description, Point3d basePoint, GeometryBase geometry, ObjectAttributes attributes)

Adds an instance definition to the instance definition table.

Add(string name, string description, Point3d basePoint, IEnumerable<GeometryBase> geometry, IEnumerable<ObjectAttributes> attributes)

Adds an instance definition to the instance definition table.

Add(string name, string description, Point3d basePoint, IEnumerable<GeometryBase> geometry)

Adds an instance definition to the instance definition table.

Add(string name, string description, string url, string urlTag, Point3d basePoint, IEnumerable<GeometryBase> geometry, IEnumerable<ObjectAttributes> attributes)

Adds an instance definition to the instance definition table.

Clear()

Marks all items as deleted.

Compact(bool ignoreUndoReferences)

Purge deleted instance definition information that is not in use. This function is time consuming and should be used in a thoughtful manner.

Delete(InstanceDefinition item)

Deletes the instance definition. This deletes all references too.

Delete(int idefIndex, bool deleteReferences, bool quiet)

Deletes the instance definition.

Delete(T item)

Deletes an item. Items that are deleted are still keeping their space, but the 'IsDeleted' flag is checked.

DestroySourceArchive(InstanceDefinition definition, bool quiet)

Destroys all source archive information. Specifically: * InstanceDefinitionGeometry.SourceArchive is set to the empty string. * SourceRelativePath is set to false * The alternative source archive path is set to the empty string. * Checksum.Zero() is used to private destroy all checksum information. * InstanceDefinition.UpdateType is set to InstanceDefinitionUpdateType.Static .

Find(string instanceDefinitionName, bool ignoreDeletedInstanceDefinitions)

Finds the instance definition with a given name.

Find(string instanceDefinitionName)

Finds the instance definition with a given name.

Find(Guid instanceId, bool ignoreDeletedInstanceDefinitions)

Finds the instance definition with a given id.

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.

GetEnumerator()

Returns the enumerator that yields all items.

GetList(bool ignoreDeleted)

Gets an array of instance definitions.

GetUnusedInstanceDefinitionName()

Gets unused instance definition name used as default when creating new instance definitions.

GetUnusedInstanceDefinitionName(string root, uint defaultSuffix)

Gets unused instance definition name used as default when creating new instance definitions.

GetUnusedInstanceDefinitionName(string root)

Gets unused instance definition name used as default when creating new instance definitions.

InstanceDefinitionIndex(Guid instanceId, bool ignoreDeletedInstanceDefinitions)

Get the index of the instance definition with a given id.

MakeSourcePathRelative(InstanceDefinition idef, bool relative, bool quiet)

Obsolete method that always returns false. Marks the source path for a linked instance definition as relative or absolute.

Modify(InstanceDefinition idef, string newName, string newDescription, bool quiet)

Modifies the instance definition name and description. Does not change instance definition ID or geometry.

Modify(InstanceDefinition idef, string newName, string newDescription, string newUrl, string newUrlTag, bool quiet)

Modifies the instance definition name, description, and url. Does not change instance definition ID or geometry.

Modify(int idefIndex, string newName, string newDescription, bool quiet)

Modifies the instance definition name and description. Does not change instance definition ID or geometry.

Modify(int idefIndex, string newName, string newDescription, string newUrl, string newUrlTag, bool quiet)

Modifies the instance definition name, description, and url. Does not change instance definition ID or geometry.

Modify(int idefIndex, UserData userData, bool quiet)

Modifies the instance definition user data. Does not change instance definition ID or geometry.

ModifyGeometry(int idefIndex, GeometryBase newGeometry, ObjectAttributes newAttributes)

ModifyGeometry(int idefIndex, IEnumerable<GeometryBase> newGeometry, IEnumerable<ObjectAttributes> newAttributes)

Modifies the instance definition geometry and replaces all references to the current definition with references to the new definition.

ModifyGeometry(int idefIndex, IEnumerable<GeometryBase> newGeometry)

ModifySourceArchive(int idefIndex, FileReference sourceArchive, InstanceDefinitionUpdateType updateType, bool quiet)

If the instance definition is linked or embedded, use SetSource to specify the source archive.

ModifySourceArchive(int idefIndex, string sourceArchive, InstanceDefinitionUpdateType updateType, bool quiet)

If the instance definition is linked or embedded, use SetSource to specify the source archive.

Purge(int idefIndex)

Purges an instance definition and its definition geometry.

RefreshLinkedBlock(InstanceDefinition definition)

Reload linked block definitions and update the Rhino display.

Undelete(int idefIndex)

Undeletes an instance definition that has been deleted by Delete()

UndoModify(int idefIndex)

Restores the instance definition to its previous state, if the instance definition has been modified and the modification can be undone.

UpdateLinkedInstanceDefinition(int idefIndex, string filename, bool updateNestedLinks, bool quiet)

Read the objects from a file and use them as the instance's definition geometry.

Nothing found