File3dmObject

Public Class

Used to store geometry table object definition and attributes in a File3dm.

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.DocObjects.ModelComponent
Rhino.FileIO.File3dmObject

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public sealed class File3dmObject : ModelComponent,
  IEquatable<File3dmObject>

The File3dmObject type exposes the following members.

Properties

Name

Description

Public Property

Attributes

Gets the attributes that are linked with this document object.

Public Property

ComponentStatus

Gets or sets the component status of the model component.

(Inherited from ModelComponent.)

Public Property

ComponentType

Returns ModelGeometry.

(Overrides

ModelComponent.ComponentType

Public Property

DeletedName

Gets the name of a component that is deleted.

(Inherited from ModelComponent.)

Public Property

Disposed

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

(Inherited from CommonObject.)

Public Property

Geometry

Gets the geometry that is linked with this document object.

Public Property

HasId

Returns a value indicating whether the component has an ID.

(Inherited from ModelComponent.)

Public Property

HasIndex

Returns a value indicating whether the component has an Index.

(Inherited from ModelComponent.)

Public Property

HasName

Returns a value indicating whether the component has a Name.

(Inherited from ModelComponent.)

Public Property

HasUserData

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

(Inherited from CommonObject.)

Public Property

Gets or sets the ID of the current instance.

(Inherited from ModelComponent.)

Public Property

IdIsLocked

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

(Inherited from ModelComponent.)

Public Property

Index

Gets or sets the model component index attribute.

(Inherited from ModelComponent.)

Public Property

IndexIsLocked

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

(Inherited from ModelComponent.)

Public Property
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.

(Inherited from ModelComponent.)

Public Property

IsComponentStatusLocked

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

(Inherited from ModelComponent.)

Public Property

IsDeleted

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

(Inherited from ModelComponent.)

Public Property

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.

(Inherited from CommonObject.)

Public Property

IsReference

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

(Inherited from ModelComponent.)

Public Property

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

(Inherited from ModelComponent.)

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

Public Property
ModelSerialNumber

A value identifying the model that manages this component.

(Inherited from ModelComponent.)

Public Property

Name

Gets or sets the Name of the object. Equivalent to this.Attributes.Name.

(Overrides

ModelComponent.Name

Public Property

NameIsLocked

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

(Inherited from ModelComponent.)

Public Property
ReferenceModelSerialNumber

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

(Inherited from ModelComponent.)

Public Property

UserData

List of custom information that is attached to this class.

(Inherited from CommonObject.)

Public Property

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.

(Inherited from CommonObject.)

Methods

Name

Description

Public Method

ClearId

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

(Inherited from ModelComponent.)

Public Method

ClearIndex

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

(Inherited from ModelComponent.)

Public Method

ClearName

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

(Inherited from ModelComponent.)

Public Method

DataCRC

Increments the Cyclic Redundancy Check value by this instance.

(Inherited from ModelComponent.)

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

Public 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.

(Inherited from CommonObject.)

Public Method

Equals(File3dmObject)

Verified that two File3dmObject items refer to the same object in a document.

Public Method

Equals(Object)

Verified that two objects refer to the same object in a document.

(Overrides Object.Equals(Object).)

Public Method

GetHashCode

Provides an hash code for this item.

(Overrides Object.GetHashCode..)

Public Method

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

(Inherited from CommonObject.)

Public Method

GetTextureMapping

Gets the texture mapping from the File3dmObject object.

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Public Method

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

(Inherited from CommonObject.)

Public Method

LockId

Locks the component Id property.

(Inherited from ModelComponent.)

Public Method

LockIndex

Locks the component Index property.

(Inherited from ModelComponent.)

Public Method

LockName

Locks the component Name property.

(Inherited from ModelComponent.)

Public Method

ToJSON

Create a JSON string representation of this object

(Inherited from CommonObject.)

Public Method
ToString

Returns the name of the model component type, and then its name and index.

(Inherited from ModelComponent.)

Public Method

TryReadUserData

Attempts to read a Rhino plug-in’s custom userdata from the File3dmObject object.