Click or drag to resize

File3dmRenderEnvironment Class

[Missing <summary> documentation for "T:Rhino.FileIO.File3dmRenderEnvironment"]

Inheritance Hierarchy

Namespace:  Rhino.FileIO
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class File3dmRenderEnvironment : File3dmRenderContent

The File3dmRenderEnvironment type exposes the following members.

Properties
  NameDescription
Public propertyAutoDelete
True if the content is automatically deleted when not in use.
(Inherited from File3dmRenderContent.)
Public propertyChildren
(Inherited from File3dmRenderContent.)
Public propertyChildSlotName
The render content's child slot name.
(Inherited from File3dmRenderContent.)
Public propertyComponentStatus
Gets or sets the component status of the model component.
(Inherited from ModelComponent.)
Public propertyComponentType
Returns RenderContent.
(Inherited from File3dmRenderContent.)
Public propertyDeletedName
Gets the name of a component that is deleted.
(Inherited from ModelComponent.)
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyFile3dmParent
The parent File3dm of the entire hierarchy.
(Inherited from File3dmRenderContent.)
Public propertyGroupId
The content's group id.
(Inherited from File3dmRenderContent.)
Public propertyHasId
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.)
Public propertyHasIndex
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.)
Public propertyHasName
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyHidden
True if the content is hidden.
(Inherited from File3dmRenderContent.)
Public propertyId
Gets or sets the ID of the current instance.
(Inherited from ModelComponent.)
Public propertyIdIsLocked
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.)
Public propertyIndex
Gets or sets the model component index attribute.
(Inherited from ModelComponent.)
Public propertyIndexIsLocked
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.)
Public propertyInstanceDefinitionModelSerialNumber
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 propertyIsChild
True if this is a child of another render content (i.e., has a parent; is not top-level).
(Inherited from File3dmRenderContent.)
Public propertyIsComponentStatusLocked
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.)
Public propertyIsDeleted
true if the component is deleted. Deleted components are kept by the document for undo purposes.
(Inherited from ModelComponent.)
Public propertyIsDocumentControlled
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 propertyIsReference
Gets a value indicting whether this component is a referenced component. Referenced components are part of referenced documents.
(Inherited from ModelComponent.)
Public propertyIsSystemComponent
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 propertyIsTopLevel
True if this is a top-level render content (i.e., has no parent; is not a child).
(Inherited from File3dmRenderContent.)
Public propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyKind
the kind of render content as a string.
(Inherited from File3dmRenderContent.)
Public propertyModelSerialNumber
A value identifying the model that manages this component.
(Inherited from ModelComponent.)
Public propertyCode exampleName
Gets or sets the name
(Inherited from ModelComponent.)
Public propertyNameIsLocked
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.)
Public propertyNotes
The content's notes.
(Inherited from File3dmRenderContent.)
Public propertyParent
The parent content or null if this is the top level object.
(Inherited from File3dmRenderContent.)
Public propertyPlugInId
The content's plug-in id.
(Inherited from File3dmRenderContent.)
Public propertyReference
True if the content is a reference content.
(Inherited from File3dmRenderContent.)
Public propertyReferenceModelSerialNumber
When a component is in a model for reference, this value identifies the reference model.
(Inherited from ModelComponent.)
Public propertyRenderEngineId
The content's render-engine id.
(Inherited from File3dmRenderContent.)
Public propertyTags
The content's tags.
(Inherited from File3dmRenderContent.)
Public propertyTopLevel
The top-level parent content. Returns this if this is the top-level item.
(Inherited from File3dmRenderContent.)
Public propertyTypeId
The unique id of the content type.
(Inherited from File3dmRenderContent.)
Public propertyTypeName
The internal name of the content type.
(Inherited from File3dmRenderContent.)
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
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.)
Top
Methods
  NameDescription
Public methodChildSlotOn
True if a particular child slot is 'on'.
(Inherited from File3dmRenderContent.)
Public methodClearId
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearIndex
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearName
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.)
Protected methodConstructConstObject
Assigns a parent object and a sub-object index to this.
(Inherited from CommonObject.)
Public methodDataCRC
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.)
Public methodDeleteChild
Deletes any existing child with the specified child slot name. True if successful, else false.
(Inherited from File3dmRenderContent.)
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Protected methodDispose(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 methodEnsurePrivateCopy
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 methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.)
Public methodFindChild
The child with the specified child slot name, or null if no such child exists.
(Inherited from File3dmRenderContent.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetParameter
Gets a named parameter. The parameter value or null if not found.
(Inherited from File3dmRenderContent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Public methodLockId
Locks the component Id property.
(Inherited from ModelComponent.)
Public methodLockIndex
Locks the component Index property.
(Inherited from ModelComponent.)
Public methodLockName
Locks the component Name property.
(Inherited from ModelComponent.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNonConstOperation
For derived classes implementers.

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

(Inherited from CommonObject.)
Protected methodOnSwitchToNonConst
Is called when a non-constant operation first occurs.
(Inherited from CommonObject.)
Public methodSetParameter
Sets a named parameter. True if the parameter was set, else false.
(Inherited from File3dmRenderContent.)
Public methodToEnvironment
Get a simulated environment that approximates this environment's appearance.
Public methodToJSON
Create a JSON string representation of this object
(Inherited from CommonObject.)
Public methodToString
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.)
Public methodXML
Gets the render content's state as an XML string.
(Inherited from File3dmRenderContent.)
Top
See Also