ModelComponent

ModelComponent class

Base class for all components in a model (document) and manages the index, id and other information common to this type of objects. This class parallels the C++ ON_ModelComponent.

inheritence: Rhino.Runtime.CommonObjectModelComponent

Namespace: Rhino.DocObjects
ModelComponent: references

Constructors (3)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

ModelComponent()

Initializes a new instance of the ModelComponent class

Properties (27)

ComponentStatus

Gets or sets the component status of the model component.

ComponentType

Gets the <b>ModelComponentType</b> for this object. Useful in switch statements.

DeletedName

Gets the name of a component that is deleted.

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

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

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

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>

IsValid

Tests an object to see if it is valid.

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.

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.

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 (24)

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,Int32 subobjectIndex)

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

DataCRC(UInt32 currentRemainder)

Increments the Cyclic Redundancy Check value by this instance.

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(Boolean 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.

FromBase64String(Int32 archive3dm,Int32 opennurbs,String base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(String json)

Create a CommonObject instance from a JSON string

GetObjectData(SerializationInfo info,StreamingContext context)

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

IsValidComponentName(String name)

Tests for a valid model component name.

IsValidWithLog(String log)

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

LockId()

Locks the component Id property.

LockIndex()

Locks the component Index property.

LockName()

Locks the component Name property.

ModelComponentTypeIgnoresCase(ModelComponentType type)

Informs the developer if a particular model component type will require case-ignoring searching within a document. This is currently True with groups; False otherwise.

ModelComponentTypeIncludesParent(ModelComponentType type)

Informs the developer if a particular model component type will include the hash of the parent.

ModelComponentTypeRequiresUniqueName(ModelComponentType type)

Informs the developer if a particular model component type will require uniqueness within a document. This is currently True with render materials and model geometry; False otherwise.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

ToString()

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

Nothing found