Properties
Number of items in the instance definitions table, excluding deleted definitions.
Overrides: CommonComponentTable<T>.ComponentType
Number of items in the instance definitions table.
Overrides: CommonComponentTable<T>.Count
Indexers
this[]
#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 null if it has been purged from the document.
Parameters:
| index (int) | zero based array index. |
Returns: The instance definition at the specified index.
Methods
public int Add(string name, string description, Point3d basePoint, GeometryBase geometry, ObjectAttributes attributes)
Adds an instance definition to the instance definition table.
Parameters:
| name (string) | The definition name. |
| description (string) | The definition description. |
| basePoint (Point3d) | A base point. |
| geometry (GeometryBase) | An element. |
| attributes (ObjectAttributes) | An attribute. |
Returns: >=0 index of instance definition in the instance definition table. -1 on failure.
public int Add(string name, string description, Point3d basePoint, IEnumerable<GeometryBase> geometry, IEnumerable<ObjectAttributes> attributes, bool overrideExisting)
Adds an instance definition to the instance definition table, optionally replacing an existing definition of the same name.
Parameters:
| name (string) | The definition name. |
| description (string) | The definition description. |
| basePoint (Point3d) | A base point. |
| geometry (IEnumerable<GeometryBase>) | An array, a list or any enumerable set of geometry. |
| attributes (IEnumerable<ObjectAttributes>) | An array, a list or any enumerable set of attributes. |
| overrideExisting (bool) | If true and a definition with this name exists, its geometry and description are replaced. The definition keeps its index, id, name, URL and user data, and every existing instance reference keeps its transform. Linked and reference definitions cannot be replaced this way, and -1 is returned for those, as it is for geometry that would make the definition reference itself. If false, a name already in use is an error: -1 is returned and a message naming the definition is printed to the command line. |
Returns: >=0 index of instance definition in the instance definition table. -1 on failure.
public int Add(string name, string description, Point3d basePoint, IEnumerable<GeometryBase> geometry, IEnumerable<ObjectAttributes> attributes)
Adds an instance definition to the instance definition table.
Parameters:
| name (string) | The definition name. |
| description (string) | The definition description. |
| basePoint (Point3d) | A base point. |
| geometry (IEnumerable<GeometryBase>) | An array, a list or any enumerable set of geometry. |
| attributes (IEnumerable<ObjectAttributes>) | An array, a list or any enumerable set of attributes. |
Returns: >=0 index of instance definition in the instance definition table. -1 on failure.
public int Add(string name, string description, Point3d basePoint, IEnumerable<GeometryBase> geometry)
Adds an instance definition to the instance definition table.
Parameters:
| name (string) | The definition name. |
| description (string) | The definition description. |
| basePoint (Point3d) | A base point. |
| geometry (IEnumerable<GeometryBase>) | An array, a list or any enumerable set of geometry. |
Returns: >=0 index of instance definition in the instance definition table. -1 on failure.
public int Add(string name, string description, string url, string urlTag, Point3d basePoint, IEnumerable<GeometryBase> geometry, IEnumerable<ObjectAttributes> attributes, bool overrideExisting)
Adds an instance definition to the instance definition table, optionally replacing an existing definition of the same name.
Parameters:
| name (string) | The definition name. |
| description (string) | The definition description. |
| url (string) | A URL or hyperlink. When overriding, null leaves the existing value unchanged and an empty string clears it. |
| urlTag (string) | A description of the URL or hyperlink. When overriding, null leaves the existing value unchanged and an empty string clears it. |
| basePoint (Point3d) | A base point. |
| geometry (IEnumerable<GeometryBase>) | An array, a list or any enumerable set of geometry. |
| attributes (IEnumerable<ObjectAttributes>) | An array, a list or any enumerable set of attributes. |
| overrideExisting (bool) | If true and a definition with this name exists, its geometry, description and URL are replaced. The definition keeps its index, id, name and user data, and every existing instance reference keeps its transform. Linked and reference definitions cannot be replaced this way, and -1 is returned for those, as it is for geometry that would make the definition reference itself. If false, a name already in use is an error: -1 is returned and a message naming the definition is printed to the command line. |
Returns: >=0 index of instance definition in the instance definition table. -1 on failure.
public int 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.
Parameters:
| name (string) | The definition name. |
| description (string) | The definition description. |
| url (string) | A URL or hyperlink. |
| urlTag (string) | A description of the URL or hyperlink. |
| basePoint (Point3d) | A base point. |
| geometry (IEnumerable<GeometryBase>) | An array, a list or any enumerable set of geometry. |
| attributes (IEnumerable<ObjectAttributes>) | An array, a list or any enumerable set of attributes. |
Returns: >=0 index of instance definition in the instance definition table. -1 on failure.
Clear
public void Clear()
Marks all items as deleted.
Purge deleted instance definition information that is not in use. This function is time consuming and should be used in a thoughtful manner.
Parameters:
| ignoreUndoReferences (bool) | If false, then deleted instance definition information that could possibly be undeleted by the Undo command will not be deleted. If true, then all deleted instance definition information is deleted. |
public int CreateFromFile(string filename, string name, InstanceDefinitionUpdateType updateType, InstanceDefinitionLayerStyle layerStyle, InstanceDefinitionNameConflictResolution conflictResolution, bool skipNestedLinkedDefinitions)
Creates an instance definition by reading a file, the way the Insert command does when inserting a file as a block. No instance reference is created.
Parameters:
| filename (string) | The name of the file to read. This can be any type of file that Rhino or a plug-in can read. |
| name (string) | The name of the instance definition to create. This must be a valid name. |
| updateType (InstanceDefinitionUpdateType) | The type of instance definition to create. |
| layerStyle (InstanceDefinitionLayerStyle) | How layers from the file appear in the model. This is used only when updateType is InstanceDefinitionUpdateType.Linked. |
| conflictResolution (InstanceDefinitionNameConflictResolution) | What to do when the model already contains an instance definition named name. |
| skipNestedLinkedDefinitions (bool) | If true, then linked instance definitions nested in the file are not read. |
Returns: The index of the new instance definition, or the index of an existing linked instance definition that already references filename. -1 on error.
public int CreateFromFile(string filename, string name, string description, string url, string urlTag, InstanceDefinitionUpdateType updateType, InstanceDefinitionLayerStyle layerStyle, InstanceDefinitionNameConflictResolution conflictResolution, bool skipNestedLinkedDefinitions)
Creates an instance definition by reading a file, the way the Insert command does when inserting a file as a block. No instance reference is created.
Parameters:
| filename (string) | The name of the file to read. This can be any type of file that Rhino or a plug-in can read. |
| name (string) | The name of the instance definition to create. This must be a valid name. |
| description (string) | The description of the instance definition. If null or empty, then the notes of the file being read, if any, are used. |
| url (string) | The URL of the instance definition. If null or empty, then the model URL of the file being read, if any, is used. |
| urlTag (string) | The URL description, or hyperlink text, of the instance definition. If null or empty, then the model URL of the file being read, if any, is used. |
| updateType (InstanceDefinitionUpdateType) | The type of instance definition to create. |
| layerStyle (InstanceDefinitionLayerStyle) | How layers from the file appear in the model. This is used only when updateType is InstanceDefinitionUpdateType.Linked. |
| conflictResolution (InstanceDefinitionNameConflictResolution) | What to do when the model already contains an instance definition named name. |
| skipNestedLinkedDefinitions (bool) | If true, then linked instance definitions nested in the file are not read. |
Returns: The index of the new instance definition, or the index of an existing linked instance definition that already references filename. -1 on error.
Deletes the instance definition. This deletes all references too.
Parameters:
| item (InstanceDefinition) | The item to delete. |
Returns: True on success.
Overrides: CommonComponentTable<T>.Delete
Deletes the instance definition.
Parameters:
| idefIndex (int) | zero based index of instance definition to delete. This must be in the range 0 <= idefIndex < InstanceDefinitionTable.Count. |
| deleteReferences (bool) | true to delete all references to this definition. false to delete definition only if there are no references. |
| quiet (bool) | If true, no warning message box appears if an instance definition cannot be deleted because it is the current layer or it contains active geometry. |
Returns: true if successful. false if the instance definition has active references and bDeleteReferences is false.
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.
Parameters:
| definition (InstanceDefinition) | The instance definition to be modified. |
| quiet (bool) | If true, then message boxes about erroneous parameters will not be shown. |
Returns: Returns true if the definition was successfully modified otherwise returns false.
Exports the block definition's component objects to one of the file formats supported by Rhino.
Finds the instance definition with a given id.
public InstanceDefinition Find(string instanceDefinitionName, bool ignoreDeletedInstanceDefinitions)
obsoleteignoreDeletedInstanceDefinitions is now redundant. Remove the second argument. Definitions are now always deleted permanently.
Finds the instance definition with a given name.
Finds the instance definition with a given name.
Parameters:
| instanceDefinitionName (string) | name of instance definition to search for (ignores case) |
Returns: The specified instance definition, or null if nothing matching was found.
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.
Overrides: CommonComponentTable<T>.GetEnumerator
Gets an array of instance definitions.
Parameters:
| ignoreDeleted (bool) | If true then deleted instance definitions are filtered out. |
Returns: An array of instance definitions. This can be empty, but not null.
Gets unused instance definition name used as default when creating new instance definitions.
Returns: An unused instance definition name string.
[CLSCompliant(false)]
public string GetUnusedInstanceDefinitionName(string root, uint defaultSuffix)
obsoleteThe defaultSuffix parameter is now ignored. Remove the second argument.
Gets unused instance definition name used as default when creating new instance definitions.
Parameters:
| root (string) | The returned name is 'root nn' If root is empty, then 'Block' (localized) is used. |
| defaultSuffix (uint) | Unique names are created by appending a decimal number to the localized term for "Block" as in "Block 01", "Block 02", and so on. When defaultSuffix is supplied, the search for an unused name begins at "Block suffix". |
Returns: An unused instance definition name string.
Gets unused instance definition name used as default when creating new instance definitions.
Parameters:
| root (string) | The returned name is 'root nn' If root is empty, then 'Block' (localized) is used. |
Returns: An unused instance definition name string.
Get the index of the instance definition with a given id.
obsoleteSource paths are always absolute at runtime. They cannot be changed.
Obsolete method that always returns false. Marks the source path for a linked instance definition as relative or absolute.
Parameters:
| idef (InstanceDefinition) | The instance definition to be marked. |
| relative (bool) | If true, the path should be considered as relative. If false, the path should be considered as absolute. |
| quiet (bool) | If true, then message boxes about erroneous parameters will not be shown. |
Returns: true if the instance definition could be modified.
Modifies the instance definition name and description. Does not change instance definition ID or geometry.
Parameters:
| idef (InstanceDefinition) | The instance definition to be modified. |
| newName (string) | The new name. |
| newDescription (string) | The new description string. |
| quiet (bool) | If false, information message boxes pop up when illegal changes are attempted. |
Returns: true if successful.
public bool 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.
Parameters:
| idef (InstanceDefinition) | The instance definition to be modified. |
| newName (string) | The new name. |
| newDescription (string) | The new description string. |
| newUrl (string) | The new URL or hyperlink. |
| newUrlTag (string) | The new description of the URL or hyperlink. |
| quiet (bool) | If false, information message boxes pop up when illegal changes are attempted. |
Returns: true if successful.
Modifies the instance definition name and description. Does not change instance definition ID or geometry.
public bool 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.
Parameters:
| idefIndex (int) | The index of the instance definition to be modified. |
| newName (string) | The new name. |
| newDescription (string) | The new description string. |
| newUrl (string) | The new URL or hyperlink. |
| newUrlTag (string) | The new description of the URL or hyperlink. |
| quiet (bool) | If false, information message boxes pop up when illegal changes are attempted. |
Returns: true if successful.
Modifies the instance definition user data. Does not change instance definition ID or geometry.
Parameters:
| idefIndex (int) | |
| newGeometry (GeometryBase) | |
| newAttributes (ObjectAttributes) |
public bool 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.
Parameters:
| idefIndex (int) | The index of the instance definition to be modified. |
| newGeometry (IEnumerable<GeometryBase>) | The new geometry. |
| newAttributes (IEnumerable<ObjectAttributes>) | The new attributes. |
Returns: true if operation succeeded.
Parameters:
| idefIndex (int) | |
| newGeometry (IEnumerable<GeometryBase>) |
Modifies the insertion plane of an instance definition. The definition's geometry is re-origined so that the supplied plane becomes the new insertion plane - its origin is the new insertion point and its axes become the definition's axes. Existing instance references are not modified, so they will appear to move. Only embedded instance definitions are supported; the function returns false for linked definitions.
Modifies the insertion point of an instance definition. The definition's geometry is re-origined so that the supplied point becomes the new insertion point - the point that aligns with the insertion location when the block is inserted. Existing instance references are not modified, so they will appear to move. Only embedded instance definitions are supported; the function returns false for linked definitions.
public bool ModifySourceArchive(int idefIndex, FileReference sourceArchive, InstanceDefinitionUpdateType updateType, bool quiet)
If the instance definition is linked or embedded, use SetSource to specify the source archive.
Parameters:
| idefIndex (int) | The index of the instance definition to be modified. |
| sourceArchive (FileReference) | The new source archive file name. |
| updateType (InstanceDefinitionUpdateType) | |
| quiet (bool) | If true, then message boxes about erroneous parameters will not be shown. |
Returns: Returns true if the definition was successfully modified otherwise returns false.
public bool ModifySourceArchive(int idefIndex, FileReference sourceArchive, InstanceDefinitionUpdateType updateType, InstanceDefinitionLayerStyle layerStyle, bool quiet)
If the instance definition is linked or embedded, use SetSource to specify the source archive.
Remarks: A linked instance definition does not remember its layer style once it has been changed to another update type. Use this overload to restore the layer style when changing an instance definition back to InstanceDefinitionUpdateType.Linked.
Parameters:
| idefIndex (int) | The index of the instance definition to be modified. |
| sourceArchive (FileReference) | The new source archive file name. |
| updateType (InstanceDefinitionUpdateType) | |
| layerStyle (InstanceDefinitionLayerStyle) | The layer style to apply when updateType is InstanceDefinitionUpdateType.Linked. Pass InstanceDefinitionLayerStyle.None to use the default layer style, which is InstanceDefinitionLayerStyle.Reference. This parameter is ignored for all other update types. |
| quiet (bool) | If true, then message boxes about erroneous parameters will not be shown. |
Returns: Returns true if the definition was successfully modified otherwise returns false.
[EditorBrowsable(EditorBrowsableState.Never)]
public bool ModifySourceArchive(int idefIndex, string sourceArchive, InstanceDefinitionUpdateType updateType, bool quiet)
obsoleteUse the overload taking a FileReference.
If the instance definition is linked or embedded, use SetSource to specify the source archive.
Parameters:
| idefIndex (int) | The index of the instance definition to be modified. |
| sourceArchive (string) | The new source archive file name. |
| updateType (InstanceDefinitionUpdateType) | |
| quiet (bool) | If true, then message boxes about erroneous parameters will not be shown. |
Returns: Returns true if the definition was successfully modified otherwise returns false.
Purges an instance definition and its definition geometry.
Parameters:
| idefIndex (int) | zero based index of instance definition to delete. This must be in the range 0 <= idefIndex < InstanceDefinitionTable.Count. |
Returns: True if successful. False if the instance definition cannot be purged because it is in use by reference objects or undo information.
Purges any unused instance definitions.
Returns: The number of unused instance definitions that were purged.
Reload linked block definitions and update the Rhino display.
Parameters:
| definition (InstanceDefinition) | Instance definition to reload. |
Returns: Returns true if the linked file was successfully read and updated.
Undeletes an instance definition that has been deleted by Delete()
Parameters:
| idefIndex (int) | zero based index of instance definition to delete. This must be in the range 0 <= idefIndex < InstanceDefinitionTable.Count. |
Returns: true if successful
Restores the instance definition to its previous state, if the instance definition has been modified and the modification can be undone.
Parameters:
| idefIndex (int) | The index of the instance definition to be restored. |
Returns: true if operation succeeded.
public bool UpdateLinkedInstanceDefinition(int idefIndex, string filename, bool updateNestedLinks, bool quiet)
Read the objects from a file and use them as the instance's definition geometry.
Parameters:
| idefIndex (int) | zero based index of instance definition to delete. This must be in the range 0 <= idefIndex < InstanceDefinitionTable.Count. |
| filename (string) | name of file (can be any type of file that Rhino or a plug-in can read) |
| updateNestedLinks (bool) | If true and the instance definition references to a linked instance definition, that needs to be updated, then the nested definition is also updated. If false, nested updates are skipped. |
| quiet (bool) |