InstanceDefinition

InstanceDefinition class

This is the same as InstanceDefinitionGeometry , but in a Rhino document.

Inheritence: Rhino.Runtime.CommonObjectRhino.DocObjects.ModelComponentRhino.Geometry.InstanceDefinitionGeometryInstanceDefinition
Derived Classes:

Namespace: Rhino.DocObjects
InstanceDefinition: references

Constructors (3)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

InstanceDefinitionGeometry()

Initializes a new block definition.

Properties (45)

ArchiveFileStatus

Returns the archive file status of a linked instance definition.

ComponentStatus

Gets or sets the component status of the model component.

ComponentType

Returns ModelComponentType.InstanceDefinition .

ComponentType

Gets the ModelComponentType for this object. Useful in switch statements.

ComponentType

Returns ModelComponentType.InstanceDefinition .

DeletedName

Gets the name of a component that is deleted.

Description

Gets or sets the description of the definition.

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

HasId

Returns a value indicating whether the component has an ID.

HasIndex

Returns a value indicating whether the component has an Index.

HasName

Returns a value indicating whether the component has a Name.

HasUserData

Gets True if this class has any custom information attached to it through UserData.

Gets or sets the ID of the current instance.

IdIsLocked

Returns a value indicating whether the component ID is already locked.

Index

Index of this instance definition in the index definition table.

Index

Gets or sets the model component index attribute.

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.

IsComponentStatusLocked

The component status itself can be locked. This returns an indication.

IsDeleted

Returns True if this instance definition is deleted. Deleted object are not saved to a file archive.

IsDeleted

True if the component is deleted. Deleted components are kept by the document for undo purposes.

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.

IsReference

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.

IsReference

Gets a value indicting whether this component is a referenced component. Referenced components are part of referenced documents.

IsSystemComponent

True if this model component is a system constant.
An incomplete list of system constant model components is below:
<ul><li>ON_ModelComponent::Unset</li><li>ON_InstanceDefinition::Empty</li><li>ON_Linetype::Unset</li><li>ON_Linetype::Continuous</li><li>ON_Linetype::ByLayer</li><li>ON_Linetype::ByParent</li><li>ON_Layer::Unset</li><li>ON_Layer::Default</li><li>ON_TextStyle::Unset</li><li>ON_TextStyle::Default</li><li>ON_TextStyle::ByLayer</li><li>ON_TextStyle::ByParent</li><li>ON_DimStyle::Unset</li><li>ON_DimStyle::Default</li><li>ON_DimStyle::DefaultInchDecimal</li><li>ON_DimStyle::DefaultInchFractional</li><li>ON_DimStyle::DefaultFootInchArchitecture</li><li>ON_DimStyle::DefaultMillimeterSmall</li><li>ON_DimStyle::DefaultMillimeterLarge</li><li>ON_DimStyle::DefaultMillimeterArchitecture</li></ul>

IsTenuous

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.

IsValid

Tests an object to see if it is valid.

LayerStyle

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.

Name

Gets or sets the name

NameIsLocked

Returns a value indicating whether the component Name is already locked.

NamePathSeparator

Returns the string "::". This is the string Rhino uses in layer full path names to separate the names of individual layers.

ObjectCount

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.

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

ReferenceModelSerialNumber

When a component is in a model for reference, this value identifies the reference model.

SkipNestedLinkedDefinitions

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.

SourceArchive

Gets the full file path for linked instance definitions.

SourceArchive

Gets the full file path for linked instance definitions.

UnitSystem

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.

UpdateType

Url

Gets or sets the URL or hyperlink of the definition.

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.

UserStringCount

Gets the amount of user strings.

Methods (48)

ClearId()

Resets the HasId property of the model component to false, if possible.

ClearIndex()

Resets the HasIndex property of the model component to false, if possible.

ClearName()

Resets the HasName property of the model component to false, if possible.

ConstructConstObject(object parentObject, int subobjectIndex)

Assigns a parent object and a sub-object index to this.

CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection, DisplayMode displayMode,Size bitmapSize, bool applyDpiScaling)

Creates a preview bitmap of the instance definition.

CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection, DisplayMode displayMode,Size bitmapSize)

Creates a preview bitmap of the instance definition.

CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection,Size bitmapSize, bool applyDpiScaling)

Creates a wireframe preview bitmap of the instance definition.

CreatePreviewBitmap(DefinedViewportProjection definedViewportProjection,Size bitmapSize)

Creates a wireframe preview bitmap of the instance definition.

CreatePreviewBitmap(Guid definitionObjectId,DefinedViewportProjection viewportProjection, DisplayMode displayMode,Size bitmapSize, bool applyDpiScaling)

Creates a preview bitmap of the instance definition.

CreatePreviewBitmap(Guid displayModeId,DefinedViewportProjection viewportProjection,IsometricCamera isometricCamera, bool drawDecorations,Size bitmapSize, bool applyDpiScaling)

Creates a preview bitmap of the instance definition.

DataCRC(uint currentRemainder)

Increments the Cyclic Redundancy Check value by this instance.

DeleteAllUserStrings()

DeleteUserString(string key)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

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.

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(object obj)