Click or drag to resize

RenderContent Class

[Missing <summary> documentation for "T:Rhino.Render.RenderContent"]

Inheritance Hierarchy

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public abstract class RenderContent : IDisposable

The RenderContent type exposes the following members.

Properties
  NameDescription
Public propertyCanBeEdited
Determines if the content can be edited.
Public propertyCategory
Category for this content.
Public propertyChildSlotName
Public propertyCppPointer
Public propertyDocument
If this content is in a document content list, the document will be returned. Otherwise null.
Public propertyDocumentAssoc
If this content is associated by a document in any way, the document will be returned. This includes copies of contents that were initially in the document. Otherwise null.
Public propertyDocumentRegistered
If this content is used by a document, including not in the content lists (for example, as a decal), the document will be returned. Otherwise null.
Public propertyFields
Rhino.Render.Fields FieldDictionary which provides access to setting and retrieving field values.
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.
Public propertyFirstChild
Return First child of this content or nullptr if none.
Public propertyHidden
Determines if the content has the hidden flag set.
Public propertyId
Instance identifier for this content.
Public propertyIsDefaultInstance
Checks if render content is default instance.
Public propertyIsHiddenByAutoDelete
Contents can be created as 'auto-delete' by certain commands such as 'PictureFrame'. These contents are automatically hidden from the user when the associated Rhino object is deleted. They are later deleted when the document is saved.
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.
Public propertyName
Instance name for this content.
Public propertyNextSibling
Return First sibling of this content or nullptr if none.
Public propertyNotes
Notes for this content.
Public propertyParent
Returns the top content in this parent/child chain.
Public propertyProxyType
Gets the proxy type of the render content
Public propertyRenderHash
Render hash for the content hierarchy. It iterates 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.
Public propertyTags
Tags for this content.
Public propertyTopLevel
Returns true if this content has no parent, false if it is the child of another content.
Public propertyTopLevelParent
Returns the top content in this parent/child chain.
Public propertyTypeDescription
Description for your content type. ie. "Procedural checker pattern"
Public propertyTypeId
Type identifier for this content
Public propertyTypeName
Name for your content type. ie. "My .net Texture"
Public propertyXml
Top
Methods
  NameDescription
Public methodAddAutomaticUserInterfaceSection
Add a new automatic user interface section, Field values which include prompts will be automatically added to this section.
Public methodAddChild(RenderContent) Obsolete.
Public methodAddChild(RenderContent, String) Obsolete.
Public methodStatic memberAddPersistentRenderContent(RenderContent) Obsolete.
Add a material, environment or texture to the internal RDK document lists as top level content. The content must have been returned from RenderContent::MakeCopy, NewContentFromType or a similar function that returns a non-document content.
Public methodStatic memberAddPersistentRenderContent(RhinoDoc, RenderContent) Obsolete.
Add a material, environment or texture to the internal RDK document lists as top level content. The content must have been returned from RenderContent::MakeCopy, NewContentFromType or a similar function that returns a non-document content.
Public methodAddUserInterfaceSection(ICollapsibleSection)
Public methodAddUserInterfaceSection(Type, String, Boolean, Boolean) Obsolete.
Add a new .NET control to an content expandable tab section, the height of the createExpanded tabs client area will be the initial height of the specified control.
Public methodBeginChange
Begins a change or batch of changes. This returns a reference to the content which you should use to make your changes. It may also make a copy of the content state allowing EndChange to send an event with the old and new contents. Calls to this method are counted; you must call EndChange() once for every call to BeginChange(). Note: If Changed() was called between the calls to BeginChange() and EndChange(), the last call to EndChange() may cause the ContentChanged event to be sent.
Public methodBindParameterToField(String, Field, RenderContentChangeContexts)
Use bindings to automatically wire parameters to fields
Public methodBindParameterToField(String, String, Field, RenderContentChangeContexts)
Use bindings to automatically wire parameters to fields
Protected methodCalculateRenderHash
Override this method to calculate the render hash of the state that affects how the content is rendered. Does not include children or perform any caching. Render hash values are now automatically cached by the content framework and you do not have to worry about caching. You also do not have to worry about iterating into children. This method is now only called internally by the framework, use the RenderHash property to get the current hash value.
Public methodChangeChild Obsolete.
Public methodChildSlotAmount
Gets the amount property for the texture in the specified child slot. Values are typically from 0.0 - 100.0
Public methodChildSlotNameFromParamName
A "child slot" is the specific "slot" that a child (usually a texture) occupies. This is generally the "use" of the child - in other words, the thing the child operates on. Some examples are "color", "transparency".
Public methodChildSlotOn
Gets the on-ness property for the texture in the specified child slot.
Public methodStatic memberCreate(Guid, RenderContentShowContentChooserFlags, RhinoDoc)
Constructs a new content of the specified type and add it to the persistent content list. This function cannot be used to create temporary content that you delete after use. Content created by this function is owned by RDK and appears in the content editor. To create a temporary content which is owned by you, call RenderContentType.NewContentFromType().
Public methodStatic memberCreate(Type, RenderContentShowContentChooserFlags, RhinoDoc)
Constructs a new content of the specified type and add it to the persistent content list. This function cannot be used to create temporary content that you delete after use. Content created by this function is owned by RDK and appears in the content editor. To create a temporary content which is owned by you, call RenderContentType.NewContentFromType().
Public methodStatic memberCreate(Guid, RenderContent, String, RenderContentShowContentChooserFlags, RhinoDoc)
Constructs a new content of the specified type and add it to the persistent content list. This function cannot be used to create temporary content that you delete after use. Content created by this function is owned by RDK and appears in the content editor. To create a temporary content which is owned by you, call RenderContentType.NewContentFromType().
Public methodStatic memberCreate(Type, RenderContent, String, RenderContentShowContentChooserFlags, RhinoDoc)
Constructs a new content of the specified type and add it to the persistent content list. This function cannot be used to create temporary content that you delete after use. Content created by this function is owned by RDK and appears in the content editor. To create a temporary content which is owned by you, call RenderContentType.NewContentFromType().
Public methodDeleteAllChildren
Public methodDeleteChild
Public methodDispose
Releases all resources used by the RenderContent
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the RenderContent and optionally releases the managed resources
Public methodDynamicIcon
Public methodEdit
Call this method to open the content in the a modal version of the editor. The content must be in the document or the call will fail.
Public methodEndChange
Ends a change or batch of changes. Calls to this method are counted; you must call this method once for every call to BeginChange(RenderContentChangeContexts). Note: If BeginChange(RenderContentChangeContexts) was called with ChangeContexts.UI, ChangeContexts.Program, ChangeContexts.Drop or ChangeContexts.UI.Tree and Changed() was called between the calls to BeginChange(RenderContentChangeContexts) and EndChange(), the last call to EndChange() will raise the ContentChanged event.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFactory
Protected methodFinalize (Overrides ObjectFinalize.)
Public methodFindChild
Public methodForDisplay
**** This method is for proxies and will be marked obsolete in V7 **** The only place a single proxy can be displayed is in the New Content Control main thumbnail. All other attempts to use a single proxy in a UI require it to be replaced with the corresponding multi proxy. Single proxies override this to find the corresponding multi proxy.
Public methodStatic memberFromId
Search for a content object based on its Id
Public methodStatic memberFromXml(String) Obsolete.
Public methodStatic memberFromXml(String, RhinoDoc)
Public methodGetChildSlotParameter
Extra requirements are a way of specifying extra functionality on parameters in the automatic UI. Implement this function to specify additional functionality for automatic UI sections or the texture summary. See IAutoUIExtraRequirements.h in the C++ RDK for string definitions for the parameter names.
Public methodGetEmbeddedFilesList
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetParameter
Query the content instance for the value of a given named parameter. If you do not support this parameter, call the base class.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIcon
Public methodInitialize
Public methodIsCompatible
Public methodIsContentTypeAcceptableAsChild
Public methodIsFactoryProductAcceptableAsChild(ContentFactory, String)
Public methodIsFactoryProductAcceptableAsChild(Guid, String, String)
Override this method to restrict the type of acceptable child content. The default implementation of this method just returns true.
Public methodIsReference
Query whether or not the content or any of its ancestors is a reference content.
Public methodIsRenderHashCached Obsolete.
This method is deprecated and no longer called. For more information see CalculateRenderHash(UInt64)
Public methodStatic memberLoadFromFile
Loads content from a library file. Does not add the content to the persistent content list. Use AddPersistantContent to add it to the list.
Public methodMakeCopy
Create a copy of the render content. All content is the same, except for the instance Id.
Public methodMatchData
Implement to transfer data from another content to this content during creation.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodModifyRenderContentStyles
Public methodNewPreviewSceneServer
Gets the PreviewSceneServer of the content
Protected methodOnAddUserInterfaceSections
Override to provide UI sections to display in the editor.
Protected methodOnGetDefaultsInteractive
Override this method to prompt user for information necessary to create a new content object. For example, if you are created a textured material you may prompt the user for a bitmap file name prior to creating the textured material.
Public methodOpenInEditor
Call this method to open the content in the relevant thumbnail editor and select it for editing by the user. The content must be in the document or the call will fail.
Public methodOpenInModalEditor Obsolete.
Call this method to open the content in the a modal version of the editor. The content must be in the document or the call will fail.
Public methodParamNameFromChildSlotName
A "child slot" is the specific "slot" that a child (usually a texture) occupies. This is generally the "use" of the child - in other words, the thing the child operates on. Some examples are "color", "transparency".
Public methodStatic memberRegisterContent(PlugIn)
Call RegisterContent in your plug-in's OnLoad function in order to register all of the custom RenderContent classes in your assembly.
Public methodStatic memberRegisterContent(Assembly, Guid)
Call RegisterContent in your plug-in's OnLoad function in order to register all of the custom RenderContent classes in your assembly.
Public methodRenderHashExclude(CrcRenderHashFlags, String)
As RenderHash, but ignore parameter names given.
Public methodRenderHashExclude(TextureRenderHashFlags, String)
As RenderHash, but ignore parameter names given.
Public methodReplace
Public methodSetChild(RenderContent, String)
Set another content as a child of this content. This content may or may not be attached to a document. If this content already has a child with the specified child slot name, that child will be deleted. If this content is not attached to a document, the child will be added without sending any events. If this content is attached to a document, the necessary events will be sent to update the UI. Note: Do not call this method to add children in your constructor. If you want to add default children, you should override Initialize() and add them there.
Public methodSetChild(RenderContent, String, RenderContentChangeContexts) Obsolete.
Set another content as a child of this content. This content may or may not be attached to a document. If this content already has a child with the specified child slot name, that child will be deleted. If this content is not attached to a document, the child will be added without sending any events. If this content is attached to a document, the necessary events will be sent to update the UI. Note: Do not call this method to add children in your constructor. If you want to add default children, you should override Initialize() and add them there.
Public methodSetChildSlotAmount
Sets the amount property for the texture in the specified child slot. Values are typically from 0.0 - 100.0
Public methodSetChildSlotOn
Sets the on-ness property for the texture in the specified child slot.
Public methodSetChildSlotParameter
Extra requirements are a way of specifying extra functionality on parameters in the automatic UI. Implement this function to support values being set from automatic UI sections or the texture summary. See IAutoUIExtraRequirements.h in the C++ RDK for string definitions for the parameter names.
Public methodSetParameter(String, Object)
Set the named parameter value for this content instance. If you do not support this parameter, call the base class.
Public methodSetParameter(String, Object, RenderContentChangeContexts) Obsolete.
Set the named parameter value for this content instance. If you do not support this parameter, call the base class.
Public methodSetRenderHash Obsolete.
This method is deprecated and no longer called. For more information see CalculateRenderHash(UInt64)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUninitialize
Public methodUseCount
UseCount returns how many times the content is used
Public methodVirtualIcon
Icon to display in the content browser, this bitmap needs to be valid for the life of this content object, the content object that returns the bitmap is responsible for disposing of the bitmap.
Top
Events
  NameDescription
Public eventStatic memberContentAdded
Used to monitor render content addition to the document.
Public eventStatic memberContentChanged
Used to monitor render content modifications.
Public eventStatic memberContentDeleted
Used to monitor render content deletion from the document.
Public eventStatic memberContentDeleting
Used to monitor render content deletion from the document.
Public eventStatic memberContentFieldChanged
This event is raised when a field value is modified.
Public eventStatic memberContentRenamed
Used to monitor render content renaming in the document.
Public eventStatic memberContentReplaced
Used to monitor render content replacing in the document.
Public eventStatic memberContentReplacing
Used to monitor render content replacing in the document.
Public eventStatic memberContentUpdatePreview
Used to monitor render content preview updates.
Public eventStatic memberCurrentEnvironmentChanged
Event fired when changes to current environments have been made. This will be one of Background, ReflectionAndRefraction or Skylighting Since 6.11
Top
Version Information

Rhino for Windows

Supported in: 6.18
See Also