File3dmRenderContent Class |
[Missing <summary> documentation for "T:Rhino.FileIO.File3dmRenderContent"]
Namespace: Rhino.FileIO
The File3dmRenderContent type exposes the following members.
Name | Description | |
---|---|---|
AutoDelete | True if the content is automatically deleted when not in use. | |
Children | ||
ChildSlotName | The render content's child slot name. | |
ComponentStatus |
Gets or sets the component status of the model component.
(Inherited from ModelComponent.) | |
ComponentType |
Returns RenderContent.
(Overrides ModelComponentComponentType.) | |
DeletedName |
Gets the name of a component that is deleted.
(Inherited from ModelComponent.) | |
Disposed |
Indicates if this object has been disposed or the
document it originally belonged to has been disposed.
(Inherited from CommonObject.) | |
File3dmParent | The parent File3dm of the entire hierarchy. | |
GroupId | The content's group id. | |
HasId |
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.) | |
HasIndex |
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.) | |
HasName |
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.) | |
HasUserData |
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.) | |
Hidden | True if the content is hidden. | |
Id |
Gets or sets the ID of the current instance.
(Inherited from ModelComponent.) | |
IdIsLocked |
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.) | |
Index |
Gets or sets the model component index attribute.
(Inherited from ModelComponent.) | |
IndexIsLocked |
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.) | |
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.) | |
IsChild | True if this is a child of another render content (i.e., has a parent; is not top-level). | |
IsComponentStatusLocked |
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.) | |
IsDeleted |
true if the component is deleted.
Deleted components are kept by the document for undo purposes.
(Inherited from ModelComponent.) | |
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.
(Inherited from ModelComponent.) | |
IsSystemComponent |
True if this model component is a system constant.
(Inherited from ModelComponent.)An incomplete list of system constant model components is below:
| |
IsTopLevel | True if this is a top-level render content (i.e., has no parent; is not a child). | |
IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) | |
Kind | the kind of render content as a string. | |
ModelSerialNumber |
A value identifying the model that manages this component.
(Inherited from ModelComponent.) | |
Name |
Gets or sets the name
(Inherited from ModelComponent.) | |
NameIsLocked |
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.) | |
Notes | The content's notes. | |
Parent | The parent content or null if this is the top level object. | |
PlugInId | The content's plug-in id. | |
Reference | True if the content is a reference content. | |
ReferenceModelSerialNumber |
When a component is in a model for reference, this value identifies the reference model.
(Inherited from ModelComponent.) | |
RenderEngineId | The content's render-engine id. | |
Tags | The content's tags. | |
TopLevel | The top-level parent content. Returns this if this is the top-level item. | |
TypeId | The unique id of the content type. | |
TypeName | The internal name of the content type. | |
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 | |
---|---|---|
ChildSlotOn | True if a particular child slot is 'on'. | |
ClearId |
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.) | |
ClearIndex |
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.) | |
ClearName |
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.) | |
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.
(Inherited from ModelComponent.) | |
DeleteChild |
Deletes any existing child with the specified child slot name.
True if successful, else false. | |
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.) | |
FindChild | The child with the specified child slot name, or null if no such child exists. | |
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.) | |
GetParameter |
Gets a named parameter.
The parameter value or null if not found. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
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.
(Inherited from ModelComponent.) | |
LockIndex |
Locks the component Index property.
(Inherited from ModelComponent.) | |
LockName |
Locks the component Name property.
(Inherited from ModelComponent.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
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.) | |
SetParameter |
Sets a named parameter.
True if the parameter was set, else false. | |
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.
(Inherited from ModelComponent.) | |
XML |
Gets the render content's state as an XML string.
|