This is the same as InstanceDefinitionGeometry, but in a Rhino document.
Properties
Returns the archive file status of a linked instance definition.
ComponentStatus
Gets or sets the component status of the model component.
Overrides: InstanceDefinitionGeometry.ComponentType
Disposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
HasUserData
Gets true if this class has any custom information attached to it through UserData.
Exceptions:
| InvalidOperationException | When setting the ID failed. This usually happened because the instance ID is already locked. |
IdIsLocked
Returns a value indicating whether the component ID is already locked.
Index of this instance definition in the index definition table.
Overrides: ModelComponent.Index
IndexIsLocked
Returns a value indicating whether the component Index is already locked.
InstanceDefinitionModelSerialNumber
When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
IsComponentStatusLocked
The component status itself can be locked. This returns an indication.
Returns true if this instance definition is deleted. Deleted object are not saved to a file archive.
Overrides: ModelComponent.IsDeleted
IsDocumentControlled
If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.
IsLinkedType
Returns true if this instance definition is linked to an external source archive, that is, if its InstanceDefinitionGeometry.UpdateType is InstanceDefinitionUpdateType.Linked or InstanceDefinitionUpdateType.LinkedAndEmbedded.
An object from a work session reference model is reference a reference object and cannot be modified. An object is a reference object if, and only if, it is on a reference layer.
Overrides: ModelComponent.IsReference
IsSystemComponent
True if this model component is a system constant.
An incomplete list of system constant model components is below:
- ON_ModelComponent::Unset
- ON_InstanceDefinition::Empty
- ON_Linetype::Unset
- ON_Linetype::Continuous
- ON_Linetype::ByLayer
- ON_Linetype::ByParent
- ON_Layer::Unset
- ON_Layer::Default
- ON_TextStyle::Unset
- ON_TextStyle::Default
- ON_TextStyle::ByLayer
- ON_TextStyle::ByParent
- ON_DimStyle::Unset
- ON_DimStyle::Default
- ON_DimStyle::DefaultInchDecimal
- ON_DimStyle::DefaultInchFractional
- ON_DimStyle::DefaultFootInchArchitecture
- ON_DimStyle::DefaultMillimeterSmall
- ON_DimStyle::DefaultMillimeterLarge
- ON_DimStyle::DefaultMillimeterArchitecture
True if this instance definition is from a linked file. It will be saved only if it is referenced by an instance reference object that is in the active geometry list and is being saved. Note that there can be multiple linked instance definitions with references to tenuous instance definitions.
Specifies how model components (layers, materials, dimension styles, etc.) from linked instance definition files appear in the active model.
ModelSerialNumber
A value identifying the model that manages this component.
Remarks: If the component is being managed by a model, this value identifies the model. In Rhino, this value is the document runtime serial number. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
Exceptions:
| InvalidOperationException | When setting the Name failed. This usually happens because the instance Name is already locked. |
NameIsLocked
Returns a value indicating whether the component Name is already locked.
Number of objects this definition uses. This counts the objects that are used to define the geometry. This does NOT count the number of references to this instance definition.
ReferenceModelSerialNumber
When a component is in a model for reference, this value identifies the reference model.
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
This property applies when an instance definition is linked. If true, when reading the file that defines the content of the linked instance definition, skip any linked instance definitions found in that file. If false, when reading the file that defines the content of the linked instance definition, recursively load linked instance definitions found in that file.
Gets the full file path for linked instance definitions.
SourceArchiveRelativePath
Gets the source archive path for linked instance definitions relative to the file that contains this definition. Empty if the definition is not linked or no relative path is stored.
Gets the unit system of the instance definition. If the instance definition was imported from another 3dm file, the unit system may differ from that of the document.
UrlDescription
Gets or sets the description of the URL or hyperlink of the definition.
UserData
List of custom information that is attached to this class.
UserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.
Methods
ClearId
public void ClearId()
Resets the HasId property of the model component to false, if possible.
Exceptions:
| InvalidOperationException | If the ID is locked. |
ClearIndex
public void ClearIndex()
Resets the HasIndex property of the model component to false, if possible.
Exceptions:
| InvalidOperationException | If the index is locked. |
ClearName
public void ClearName()
Resets the HasName property of the model component to false, if possible.
Exceptions:
| InvalidOperationException | If the name is locked. |
ConstructConstObject
Assigns a parent object and a sub-object index to this.
public Bitmap CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection, DisplayMode displayMode, Size bitmapSize, bool applyDpiScaling)
Creates a preview bitmap of the instance definition.
Parameters:
| definedViewportProjection (DefinedViewportProjection) | The view projection. |
| displayMode (DisplayMode) | The display mode. |
| bitmapSize (Size) | The bitmap size in pixels. |
| applyDpiScaling (bool) | Specify true to apply DPI scaling (Windows-only). |
Returns: The preview bitmap if successful, null otherwise.
public Bitmap CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection, DisplayMode displayMode, Size bitmapSize)
Creates a preview bitmap of the instance definition.
Parameters:
| definedViewportProjection (DefinedViewportProjection) | The view projection. |
| displayMode (DisplayMode) | The display mode. |
| bitmapSize (Size) | The bitmap size in pixels. |
Returns: The preview bitmap if successful, null otherwise.
public Bitmap CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection, Size bitmapSize, bool applyDpiScaling)
Creates a wireframe preview bitmap of the instance definition.
Parameters:
| definedViewportProjection (DefinedViewportProjection) | The view projection. |
| bitmapSize (Size) | The bitmap size in pixels. |
| applyDpiScaling (bool) | Specify true to apply DPI scaling (Windows-only). |
Returns: The preview bitmap if successful, null otherwise.
public Bitmap CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection, Size bitmapSize)
Creates a wireframe preview bitmap of the instance definition.
Parameters:
| definedViewportProjection (DefinedViewportProjection) | The view projection. |
| bitmapSize (Size) | The bitmap size in pixels. |
Returns: The preview bitmap if successful, null otherwise.
public Bitmap CreatePreviewBitmap(Guid definitionObjectId, DefinedViewportProjection viewportProjection, DisplayMode displayMode, Size bitmapSize, bool applyDpiScaling)
Creates a preview bitmap of the instance definition.
Parameters:
| definitionObjectId (Guid) | Id of one of this definition's objects to draw selected. |
| viewportProjection (DefinedViewportProjection) | The view projection. |
| displayMode (DisplayMode) | The display mode. |
| bitmapSize (Size) | The bitmap size in pixels. |
| applyDpiScaling (bool) | Specify true to apply DPI scaling (Windows-only). |
Returns: The preview bitmap if successful, null otherwise.
public Bitmap CreatePreviewBitmap(Guid displayModeId, DefinedViewportProjection viewportProjection, IsometricCamera isometricCamera, bool drawDecorations, Size bitmapSize, bool applyDpiScaling)
Creates a preview bitmap of the instance definition.
Parameters:
| displayModeId (Guid) | The id of the display mode to draw with. |
| viewportProjection (DefinedViewportProjection) | The view projection. |
| isometricCamera (IsometricCamera) | The isometric camera angle. |
| drawDecorations (bool) | Specify true to draw viewport decorations, such as grid and axes. |
| bitmapSize (Size) | The bitmap size in pixels. |
| applyDpiScaling (bool) | Specify true to apply DPI scaling (Windows-only). |
Returns: The preview bitmap if successful, null otherwise.
DataCRC
Increments the Cyclic Redundancy Check value by this instance.
Parameters:
| currentRemainder (uint) | The current remainder value. |
Returns: The updated remainder value.
DeleteAllUserStrings
public void DeleteAllUserStrings()
Deletes all user strings attached to this geometry.
DeleteUserString
Deletes the user string with the specified key from this geometry.
Parameters:
| key (string) | The key of the user string to delete. |
Returns: True if the user string was deleted or did not exist; otherwise, false.
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
Dispose
For derived class implementers.
This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.
Also, you must call the base virtual method within your overriding method.
Parameters:
| disposing (bool) | true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer. |
EnsurePrivateCopy
public void EnsurePrivateCopy()
If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.
Equals
#Equality is checked against InstanceDefinition.Id
Gets a list of all the InstanceDefinitions that contain a reference this InstanceDefinition.
Returns: An array of instance definitions. The returned array can be empty, but not null.
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
GetObjectIds
Returns the unique identifiers of all objects that are part of this instance definition's geometry table.
Returns: An array of Guid values representing the object IDs in the instance geometry table.
Gets an array with the objects that belong to this instance definition.
Returns: An array of Rhino objects. The returned array can be empty, but not null.
Gets a list of the CRhinoInstanceObjects (inserts) that contains a reference this instance definition.
Parameters:
| wheretoLook (int) | 0 = get top level references in active document. 1 = get top level and nested references in active document. 2 = check for references from other instance definitions. |
Returns: An array of instance objects. The returned array can be empty, but not null.
Parameters:
| key (string) | id used to retrieve the string. |
Returns: string associated with the key if successful. null if no key was found.
GetUserStrings
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Returns: A new collection.
Determines whether the instance definition is referenced.
Parameters:
| wheretoLook (int) | 0 = check for top level references in active document. 1 = check for top level and nested references in active document. 2 = check for references in other instance definitions. |
Returns: true if the instance definition is used; otherwise false.
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: true if this object is valid; false otherwise.
LockId
public void LockId()
Locks the component Id property.
LockIndex
public void LockIndex()
Locks the component Index property.
LockName
public void LockName()
Locks the component Name property.
NonConstOperation
protected virtual void NonConstOperation()
For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.
returns an object used as part of this definition.
Parameters:
| index (int) | 0 <= index < ObjectCount. |
Returns: Returns an object that is used to define the geometry. Does NOT return an object that references this definition.count the number of references to this instance.
OnSwitchToNonConst
protected virtual void OnSwitchToNonConst()
Is called when a non-constant operation first occurs.
SetUserString
Attach a user string (key,value combination) to this geometry.
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |
ToString
Returns the name of the model component type, and then its name and index.
Remarks: This is provided as a visual aid. Do not rely on this for serialization.
Overrides: Object.ToString
Returns the number of references of this instance definition in the model. Both top-level references and nested instances are included in the count.
Returns: The number of references of this instance definition in the model.
Returns the number of references of this instance definition in the model. Both top-level references and nested instances are included in the count.
Determines if this instance definition contains a reference to another instance definition.
Parameters:
| otherIdefIndex (int) | index of another instance definition. |
Returns: 0 no 1 other_idef_index is the index of this instance definition >1 This InstanceDefinition uses the instance definition and the returned value is the nesting depth.
Returns true if some object in the instance definition is on the layer with the specified layer index.
Parameters:
| layerIndex (int) | The index of layer to search for. |
Returns: True if there is an object in the instance definition that is on the layer.
Returns true if some object in the instance definition references the linetype with the specified linetype index.
Parameters:
| linetypeIndex (int) | The index of linetype to search for. |
Returns: True if there is an object in the instance definition that references that linetype.