ModelComponent Class |
This class parallels the C++ ON_ModelComponent.
Namespace: Rhino.DocObjects
The ModelComponent type exposes the following members.
Name | Description | |
---|---|---|
ComponentStatus |
Gets or sets the component status of the model component.
| |
ComponentType |
Gets the ModelComponentType 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.
(Inherited from CommonObject.) | |
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.
(Inherited from CommonObject.) | |
Id |
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.
(Inherited from CommonObject.) | |
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:
| |
IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) | |
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.
| |
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.
(Inherited from CommonObject.) | |
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.) |
Name | Description | |
---|---|---|
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 |
Assigns a parent object and a sub-object index to this.
(Inherited from CommonObject.) | |
DataCRC |
Increments the Cyclic Redundancy Check value by this instance.
| |
Dispose |
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.) | |
Dispose(Boolean) |
For derived class implementers.
(Inherited from CommonObject.)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.
(Inherited from CommonObject.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsValidComponentName |
Tests for a valid model component name.
| |
IsValidWithLog |
Determines if an object is valid. Also provides a report on errors if this
object happens not to be valid.
(Inherited from CommonObject.) | |
LockId |
Locks the component Id property.
| |
LockIndex |
Locks the component Index property.
| |
LockName |
Locks the component Name property.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ModelComponentTypeIgnoresCase |
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 |
Informs the developer if a particular model component type will include the hash of the parent.
| |
ModelComponentTypeRequiresUniqueName |
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.
(Inherited from CommonObject.)Defines the necessary implementation to free the instance from being constant. | |
OnSwitchToNonConst |
Is called when a non-constant operation first occurs.
(Inherited from CommonObject.) | |
ToJSON |
Create a JSON string representation of this object
(Inherited from CommonObject.) | |
ToString |
Returns the name of the model component type, and then its name and index.
(Overrides ObjectToString.) |