Click or drag to resize

RenderEnvironment Properties

The RenderEnvironment type exposes the following members.

Properties
  NameDescription
Public propertyCanBeEdited
Determines if the content can be edited.
(Inherited from RenderContent.)
Public propertyCategory
Category for this content.
(Inherited from RenderContent.)
Public propertyChildSlotDisplayName
Returns the localized display name of the child slot name
(Inherited from RenderContent.)
Public propertyChildSlotName (Inherited from RenderContent.)
Public propertyCppPointer (Inherited from RenderContent.)
Public propertyStatic memberCurrentEnvironment Obsolete.
Public propertyDisplayName
Display name for this content.
(Inherited from RenderContent.)
Public propertyDocument Obsolete.
Obsolete. Do not use. You should use DocumentOwner instead.
(Inherited from RenderContent.)
Public propertyDocumentAssoc
If this render content is associated with a document in any way, the document will be returned. This includes copies of render contents that were attached to a document when the copy was made. Otherwise returns null.
(Inherited from RenderContent.)
Public propertyDocumentOwner
If this render content is owned by a document, the document will be returned. This is the same as getting the document the render content is attached to. Otherwise returns null.
(Inherited from RenderContent.)
Public propertyDocumentRegistered Obsolete.
Obsolete. Do not use. You should use DocumentOwner instead.
(Inherited from RenderContent.)
Public propertyFields
Rhino.Render.Fields FieldDictionary which provides access to setting and retrieving field values.
(Inherited from RenderContent.)
Public propertyFilename
If the content is file based, this function can be overridden to deal with setting/getting the filename. Corresponds to IRhRdkFileBasedContent in the C++ SDK
(Inherited from RenderContent.)
Public propertyFilesToEmbed
A string array of full paths to files used by the content that may be embedded in .3dm files and library files (.rmtl, .renv, .rtex). The default implementation returns an empty string list. Override this to return the file name or file names used by your content. This is typically used by textures that reference files containing the texture imagery.
(Inherited from RenderContent.)
Public propertyFirstChild
Return First child of this content or null if none.
(Inherited from RenderContent.)
Public propertyGroupId
Group ID of the content
(Inherited from RenderContent.)
Public propertyHidden
Gets or sets the render content's 'hidden' state. This feature only works for top-level render contents because it hides the entire hierarchy. It is normally used for 'implementation detail' render contents. For expert use only. Hidden render contents are never shown in the UI, with the exception of the Object (or Layer) Material Properties UI which always shows whatever is assigned to the object (or layer). In the Object (or Layer) Material Properties UI, if the user drops down the list, hidden render contents are not listed. Hidden render contents, being part of the document content list, will be listed by any scripts or other code that iterates over the document render content list. It is recommended that you set IsHidden once when you create your render content and leave it on to prevent flicker or slow performance.
(Inherited from RenderContent.)
Public propertyId
Instance identifier for this content.
(Inherited from RenderContent.)
Public propertyIsDefaultInstance
Checks if render content is default instance.
(Inherited from RenderContent.)
Public propertyIsHiddenByAutoDelete
Contents can be created as 'auto-delete' by certain commands such as 'Picture'. These contents are automatically hidden from the user when the associated Rhino object is deleted. They are later deleted when the document is saved.
(Inherited from RenderContent.)
Public propertyIsLocked
Set this property to true prior to adding content to the document to lock the content browser editing UI methods. Setting this to true will keep the browser from allowing things like deleting, renaming or changing content. This is useful for custom child content that you want to be editable but persistent. Setting this after adding content to the document will cause an exception to be thrown.
(Inherited from RenderContent.)
Public propertyName
Instance 'raw' name for this content.
(Inherited from RenderContent.)
Public propertyNextSibling
Return First sibling of this content or null if none.
(Inherited from RenderContent.)
Public propertyNotes
Notes for this content.
(Inherited from RenderContent.)
Public propertyParent
Returns the top content in this parent/child chain.
(Inherited from RenderContent.)
Public propertyProxyType
Gets the proxy type of the render content
(Inherited from RenderContent.)
Public propertyRenderHash
Render hash for the content hierarchy. It iterates over children and includes a caching mechanism which means the hash value can be retrieved quickly if it hasn't changed. The cache is invalidated when Changed() is called. You can override the CalculateRenderHash(UInt64) method to provide a custom hash value.
(Inherited from RenderContent.)
Public propertyStyles (Inherited from RenderContent.)
Public propertyTags
Tags for this content.
(Inherited from RenderContent.)
Public propertyTextureChildSlotName
Public propertyTopLevel
Returns true if this content has no parent, false if it is the child of another content.
(Inherited from RenderContent.)
Public propertyTopLevelParent
Returns the top content in this parent/child chain.
(Inherited from RenderContent.)
Public propertyTypeDescription
Description for your content type. i.e., "Procedural checker pattern"
(Inherited from RenderContent.)
Public propertyTypeId
Type identifier for this content
(Inherited from RenderContent.)
Public propertyTypeName
Name for your content type. i.e., "My .net Texture"
(Inherited from RenderContent.)
Public propertyXml (Inherited from RenderContent.)
Top
See Also