Click or drag to resize

RenderEnvironment Methods

The RenderEnvironment type exposes the following members.

Methods
  NameDescription
Public methodAddAutomaticUserInterfaceSection
Add a new automatic user interface section, Field values which include prompts will be automatically added to this section.
(Inherited from RenderContent.)
Public methodAddChild(RenderContent) Obsolete. (Inherited from RenderContent.)
Public methodAddChild(RenderContent, String) Obsolete. (Inherited from RenderContent.)
Public methodAddUserInterfaceSection(ICollapsibleSection) (Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodBeginCreateDynamicFields
Automatic Dynamic Field support. Dynamic fields are typically created in the constructor of RenderContent and they are therefore created automatically whenever the content is created. However, some advanced users require the fields to be created in response to some user action which occurs much later. This creates the problem that the fields do not exist by default and therefore cannot be loaded when the document is loaded. These methods are provided to solve that problem by making it possible to automatically create the dynamic fields on loading if they don't already exist. Dynamic fields that have this auto-create-on-load behavior are referred to as automatic dynamic fields. Dynamic fields that do not require the advanced automatic feature can still be created by using these methods (recommended), or they can be created manually (legacy usage). You must call this before creating any dynamic fields. Calls to this method are counted; you must call EndCreateDynamicFields() once for every call to BeginCreateDynamicFields().
(Inherited from RenderContent.)
Public methodBindParameterToField(String, Field, RenderContentChangeContexts)
Use bindings to automatically wire parameters to fields
(Inherited from RenderContent.)
Public methodBindParameterToField(String, String, Field, RenderContentChangeContexts)
Use bindings to automatically wire parameters to fields
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodChangeChild Obsolete. (Inherited from RenderContent.)
Public methodChildSlotAmount
Gets the amount property for the texture in the specified child slot. Values are typically from 0.0 - 100.0
(Inherited from RenderContent.)
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".
(Inherited from RenderContent.)
Public methodChildSlotOn
Gets the on-ness property for the texture in the specified child slot.
(Inherited from RenderContent.)
Public methodConvertUnits
Modify your content so that it is converted from meters into the units of the unit system. No need to call the base class when you override this, and no need to recurse into children.
(Inherited from RenderContent.)
Public methodCreateDynamicField
Create a dynamic field with an initial value and min and max limits.
(Inherited from RenderContent.)
Public methodDeleteAllChildren (Inherited from RenderContent.)
Public methodDeleteChild (Inherited from RenderContent.)
Public methodDispose (Inherited from RenderContent.)
Protected methodDispose(Boolean) (Inherited from RenderContent.)
Public methodDynamicIcon (Inherited from RenderContent.)
Public methodEdit
This method allows a render content hierarchy to be edited using a modal (AKA 'pop-up') editor. If the original render content is in a document, it will remain there, and the edited one will be 'free-floating'. Therefore it is the caller's responsibility to do any replacement in the document if required. The returned new content will be owned by the caller.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodEndCreateDynamicFields
You must call this after creating dynamic fields. Calls to this method are counted; you must call BeginCreateDynamicFields() once for every call to EndCreateDynamicFields().
(Inherited from RenderContent.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFactory (Inherited from RenderContent.)
Protected methodFinalize (Inherited from RenderContent.)
Public methodFindChild (Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodGetEmbeddedFilesList (Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUiHash
This allows a content to have more than one UI for the same content type.
(Inherited from RenderContent.)
Public methodGetUnderlyingInstances (Inherited from RenderContent.)
Public methodIcon (Inherited from RenderContent.)
Public methodInitialize Obsolete. (Inherited from RenderContent.)
Public methodIsCompatible (Inherited from RenderContent.)
Public methodIsContentTypeAcceptableAsChild (Inherited from RenderContent.)
Public methodIsFactoryProductAcceptableAsChild(ContentFactory, String) (Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodIsReference
Query whether or not the content or any of its ancestors is a reference content.
(Inherited from RenderContent.)
Public methodIsRenderHashCached Obsolete.
This method is deprecated and no longer called. For more information see CalculateRenderHash(UInt64)
(Inherited from RenderContent.)
Public methodMakeCopy
Create a copy of the render content. All content is the same, except for the instance Id.
(Inherited from RenderContent.)
Public methodMakeGroupInstance
Create an 'instance' of the content tree and group the new tree with this tree. If the instance is subsequently attached to the same document, the state of all members of the group will be kept synchronized.With the exception of the instance ids, all state is exactly preserved in the new instance tree. \note The grouping will have no effect until the new instance is attached to the same document.
(Inherited from RenderContent.)
Public methodMatchData
Implement to transfer data from another content to this content during creation.
(Inherited from RenderContent.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodModifyRenderContentStyles (Inherited from RenderContent.)
Public methodStatic memberNewBasicEnvironment(SimulatedEnvironment)
Constructs a new RenderEnvironment from a SimulatedEnvironment.
Public methodStatic memberNewBasicEnvironment(SimulatedEnvironment, RhinoDoc)
Public methodNewPreviewSceneServer
Gets the PreviewSceneServer of the content
(Inherited from RenderContent.)
Protected methodOnAddUserInterfaceSections
Override to provide UI sections to display in the editor.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Protected methodOnMakeCopy
Override this function to supplement the standard copying behavour for your RenderContent.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
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".
(Inherited from RenderContent.)
Public methodRenderHashExclude(CrcRenderHashFlags, String)
As RenderHash, but ignore parameter names given.
(Inherited from RenderContent.)
Public methodRenderHashExclude(TextureRenderHashFlags, String)
As RenderHash, but ignore parameter names given.
(Inherited from RenderContent.)
Public methodRenderHashExclude(CrcRenderHashFlags, String, LinearWorkflow)
As RenderHash, but ignore parameter names given. Use this version of the function to calculate a render hash when you have the linear workflow information and you are not running on the main thread. Access to LinearWorkflow data requires document access. CrcRenderHashFlags.ExcludeLinearWorkflow must be specified.
(Inherited from RenderContent.)
Public methodReplace (Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodSetChildSlotAmount
Sets the amount property for the texture in the specified child slot. Values are typically from 0.0 - 100.0
(Inherited from RenderContent.)
Public methodSetChildSlotOn
Sets the on-ness property for the texture in the specified child slot.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodSetIsRenderHashRecursive
By default, RenderHash() recurses into children when computing the render CRC. However, some applications may require children to be excluded from the render CRC calculation. Call this method to enable or disable recursing into children. see RenderHash
(Inherited from RenderContent.)
Public methodSetName
Set instance name for this content
(Inherited from RenderContent.)
Public methodSetParameter(String, Object)
Set the named parameter value for this content instance. If you do not support this parameter, call the base class.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public methodSetRenderHash Obsolete.
This method is deprecated and no longer called. For more information see CalculateRenderHash(UInt64)
(Inherited from RenderContent.)
Public methodSimulateEnvironment(Boolean)
Public methodSimulateEnvironment(SimulatedEnvironment, Boolean)
Public methodSmartUngroupRecursive
Remove this content and all its children from any instance groups they may be a member of. If any content in the same document is left alone in the group, that content is also ungrouped. Records undo and sends events OnContentChanged and OnContentGroupIdChanged. \note This method is designed to be called from a content UI and is intended for RDK internal use but may be used as an expert user override.
(Inherited from RenderContent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUngroup
Remove this content from any instance group it may be a member of. Does not record undo but does send the OnContentGroupIdChanged event.
(Inherited from RenderContent.)
Public methodUngroupRecursive
Remove this content and all its children from any instance groups they may be a member of. Does not record undo but does send the OnContentGroupIdChanged event.
(Inherited from RenderContent.)
Public methodUninitialize Obsolete. (Inherited from RenderContent.)
Public methodUseCount
UseCount returns how many times the content is used
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Top
See Also