File3dmRenderContent

Public Class

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.DocObjects.ModelComponent
Rhino.FileIO.File3dmRenderContent
Rhino.FileIO.File3dmRenderEnvironment
Rhino.FileIO.File3dmRenderMaterial
Rhino.FileIO.File3dmRenderTexture

Namespace: Rhino.FileIO

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public abstract class File3dmRenderContent : ModelComponent

The File3dmRenderContent type exposes the following members.

Properties

Name

Description

Public Property

AutoDelete

True if the content is automatically deleted when not in use.

Public Property

Children

Public Property

ChildSlotName

The render content’s child slot name.

Public Property

ComponentStatus

Gets or sets the component status of the model component.

(Inherited from ModelComponent.)

Public Property

ComponentType

Returns RenderContent.

(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

File3dmParent

The parent File3dm of the entire hierarchy.

Public Property

GroupId

The content’s group id.

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

Hidden

True if the content is hidden.

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

IsChild

True if this is a child of another render content (i.e., has a parent; is not top-level).

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

IsTopLevel

True if this is a top-level render content (i.e., has no parent; is not a child).

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

Public Property

Kind

the kind of render content as a string.

Public Property
ModelSerialNumber

A value identifying the model that manages this component.

(Inherited from ModelComponent.)

Public Property
Code Example

Name

Gets or sets the name

(Inherited from ModelComponent.)

Public Property

NameIsLocked

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

(Inherited from ModelComponent.)

Public Property

Notes

The content’s notes.

Public Property

Parent

The parent content or null if this is the top level object.

Public Property

PlugInId

The content’s plug-in id.

Public Property

Reference

True if the content is a reference content.

Public Property
ReferenceModelSerialNumber

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

(Inherited from ModelComponent.)

Public Property

RenderEngineId

The content’s render-engine id.

Public Property

Methods

Name

Description

Public Method

ChildSlotOn

True if a particular child slot is ‘on’.

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

Protected Method

ConstructConstObject

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

(Inherited from CommonObject.)

Public Method

DataCRC

Increments the Cyclic Redundancy Check value by this instance.

(Inherited from ModelComponent.)

Public Method

DeleteChild

Deletes any existing child with the specified child slot name. True if successful, else false.

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

Protected Method

Dispose(Boolean)

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.

(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

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Inherited from CommonObject.)

Public Method

FindChild

The child with the specified child slot name, or null if no such child exists.

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Public Method

GetObjectData

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

(Inherited from CommonObject.)

Public Method

GetParameter

Gets a named parameter. The parameter value or null if not found.

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

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Protected Method

NonConstOperation

For derived classes implementers.

Defines the necessary implementation to free the instance from being constant.

(Inherited from CommonObject.)

Protected Method

OnSwitchToNonConst

Is called when a non-constant operation first occurs.

(Inherited from CommonObject.)

Public Method

SetParameter

Sets a named parameter. True if the parameter was set, else false.

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

XML

Gets the render content’s state as an XML string.