RenderContent

RenderContent class

Base class for all RenderContent - RenderMaterial, RenderTexture and RenderEnvironment Contents have a unique type id which is the same for all instances of the same class and an instance id which is unique for each instance.They know how to provide a shader for rendering, how to read and write their state as XML and how to create their own user interfaces. There are two flavors of content in the RDK -- temporary and persistent.It is very important to understand the distinction between a temporary content instance and a persistent content instance, and the fact that a temporary instance (and all its children) can become persistent.Persistent content is registered with a document and is usually(but not always) owned by it. Temporary contents get created and deleted very often during the normal operation of the RDK.In fact, just about anything the user clicks on might result in a temporary content being created and deleted again.They are created by the content browser, the thumbnail rendering, and so on.They are 'free floating' and are owned by whomever created them.They do not appear in the modeless UI, they do not get saved in the 3dm file, and they can freely be deleted again after use. Contrast this with persistent contents which are attached to a document.They are always owned by RDK, appear in the modeless UI and get saved in the 3dm file. Pointers to persistent contents should never be stored by clients; you should only store their instance ids and look them up again using RenderContent.FromId. They can be deleted only after detaching them from the document. RenderContent::Create is the highest-level function for creating a content.It creates it, initializes it, adds it to the document and sends many events.It even records undo.You cannot call this method from just anywhere. It must only be called by 'UI code'; scripts or buttons on a dialog.It results in a persistent (usually top-level) content being attached to the document and appearing in all the RDK UI elements that display contents, like the thumbnail and tree views.If you call this method and specify a parent and child-slot name, your new content will be attached to the document-resident parent as a child and the UI will be updated accordingly. The important point is that everything is temporary while the content structure is being built. Only after the whole structure is complete will the top-level parent be attached to the document making the whole structure persistent.

Derived Classes: RenderEnvironmentRenderMaterialRenderTexture

Namespace: Rhino.Render
RenderContent: references

Properties (34)

CanBeEdited

Determines if the content can be edited.

Category

Category for this content.

ChildSlotDisplayName

Returns the localized display name of the child slot name

ChildSlotName

CppPointer

DisplayName

Display name for this content.

Document

Obsolete. Do not use. You should use DocumentOwner instead.

DocumentAssoc

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.

DocumentOwner

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.

DocumentRegistered

Obsolete. Do not use. You should use DocumentOwner instead.

Fields

Rhino.Render.Fields FieldDictionary which provides access to setting and retrieving field values.

Filename

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

FilesToEmbed

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.

FirstChild

Return First child of this content or None if none.

GroupId

Group ID of the content

Hidden

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.

Instance identifier for this content.

IsDefaultInstance

Checks if render content is default instance.

IsHiddenByAutoDelete

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.

IsLocked

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.

Name

Instance 'raw' name for this content.

NextSibling

Return First sibling of this content or None if none.

Notes

Notes for this content.

Parent

Returns the top content in this parent/child chain.

ProxyType

Gets the proxy type of the render content

RenderHash

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 method to provide a custom hash value.

Styles

Tags

Tags for this content.

TopLevel

Returns True if this content has no parent, False if it is the child of another content.

TopLevelParent

Returns the top content in this parent/child chain.

TypeDescription

Description for your content type. i.e., "Procedural checker pattern"

TypeId

Type identifier for this content

TypeName

Name for your content type. i.e., "My .net Texture"

Xml

Methods (93)

AddAutomaticUserInterfaceSection(string caption, int id)

Add a new automatic user interface section, Field values which include prompts will be automatically added to this section.

AddChild(RenderContent renderContent,String childSlotName)

AddChild(RenderContent renderContent)

AddPersistentRenderContent(RenderContent renderContent)

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. Obsolete - use RhinoDoc.RenderMaterials.Add or similar.

AddPersistentRenderContent(RhinoDoc document, RenderContent renderContent)

AddUserInterfaceSection(ICollapsibleSection section)

AddUserInterfaceSection(Type classType, string caption, bool createExpanded, bool createVisible)

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.

BeginChange(ChangeContexts changeContext)

Begins a change or batch of 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.

BeginCreateDynamicFields(bool automatic)

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

BindParameterToField(string parameterName, Field field, ChangeContexts setEvent)

Use bindings to automatically wire parameters to fields

BindParameterToField(string parameterName, string childSlotName, Field field, ChangeContexts setEvent)

Use bindings to automatically wire parameters to fields

CalculateRenderHash(ulong rcrcFlags)

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.

CalculateRenderHash2(CrcRenderHashFlags flags, string excludeParameterNames)

ChangeChild(RenderContent oldContent, RenderContent newContent)

ChildSlotAmount(String childSlotName)

Gets the amount property for the texture in the specified child slot.

ChildSlotNameFromParamName(String paramName)

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

ChildSlotOn(String childSlotName)

Gets the on-ness property for the texture in the specified child slot.

ConvertUnits(UnitSystem from, UnitSystem to)

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.

Create(RhinoDoc doc,Guid type, RenderContent parent, string childSlotName)

Constructs a new content of the specified type and attaches it to a document. 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.NewContentFromTypeId().

Create(RhinoDoc doc,Guid type)

Create(RhinoDoc doc,Type type, RenderContent parent, string childSlotName)

Create(RhinoDoc doc,Type type)

Create(Guid type, RenderContent parent,String childSlotName, ShowContentChooserFlags flags, RhinoDoc doc)

Create(Guid type, ShowContentChooserFlags flags, RhinoDoc doc)

Create(Type type, RenderContent parent,String childSlotName, ShowContentChooserFlags flags, RhinoDoc doc)

Create(Type type, ShowContentChooserFlags flags, RhinoDoc doc)

CreateDynamicField(string internalName, string localName, string englishName, object value, object minValue, object maxValue, int sectionId)

Create a dynamic field with an initial value and min and max limits.

DeleteAllChildren(ChangeContexts changeContexts)

DeleteChild(string childSlotName, ChangeContexts changeContexts)

Dispose()

Dispose(bool disposing)

Dispose

DynamicIcon(Size size, out Bitmap bitmap, DynamicIconUsage usage)

Edit()

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.

EndChange()

Ends a change or batch of changes. Calls to this method are counted; you must call this method once for every call to BeginChange . Note: If BeginChange was called with ChangeContexts.UI, ChangeContexts.Program, ChangeContexts.Drop or ChangeContexts.UI.Tree and Changed() was called between the calls to BeginChange and EndChange(), the last call to EndChange() will raise the ContentChanged event.

EndCreateDynamicFields()

You must call this after creating dynamic fields. Calls to this method are counted; you must call BeginCreateDynamicFields() once for every call to EndCreateDynamicFields().

Factory()

FindChild(String childSlotName)

ForDisplay()

**** This method is for proxies and will be marked obsolete in the future **** 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.

FromId(RhinoDoc document,Guid id)

Search for a content object based on its Id

FromXml(String xml, RhinoDoc doc)

Creates a new content from the XML data. The resulting content will not be attached to the document.

FromXml(String xml)

GenerateQuickContentPreview(RenderContent c, int width, int height, PreviewSceneServer psc, bool bSuppressLocalMapping, int reason,Result result)

Generate a quick render content preview

GenerateRenderContentPreview(LinearWorkflow lwf, RenderContent c, int width, int height, bool bSuppressLocalMapping, PreviewJobSignature pjs, PreviewAppearance pa,PreviewRenderResult result)

Generate a render content preview

GetChildSlotParameter(String contentParameterName,String extraRequirementParameter)

Extra requirements are a way of specifying extra functionality on parameters in the automatic UI. Override this function to specify additional functionality for automatic UI sections or the texture summary. See IAutoUIExtraRequirements.h in the C++ RDK SDK for string definitions for the parameter names. Call the base class from your override if you do not support the extra requirement parameter. Please do not call this function. It is only retained for backward compatibility. You should instead call GetExtraRequirementParameter().

GetEmbeddedFilesList()

GetExtraRequirementParameter(string contentParameterName, string extraRequirementParameter)

Extra requirements are a way of specifying extra functionality on parameters in the automatic UI. See IAutoUIExtraRequirements.h in the C++ RDK SDK for string definitions for the parameter names.

GetParameter(String parameterName)

Query the content instance for the value of a given named parameter. If you do not support this parameter, call the base class.

GetUiHash()

This allows a content to have more than one UI for the same content type.

GetUnderlyingInstances(ref RenderContentCollection collection)

Icon(Size size, out Bitmap bitmap)

Initialize()

IsCompatible(Guid renderEngineId)

IsContentTypeAcceptableAsChild(Guid type,String childSlotName)

IsFactoryProductAcceptableAsChild(ContentFactory factory,String childSlotName)

IsFactoryProductAcceptableAsChild(Guid kindId, string factoryKind, string childSlotName)

Override this method to restrict the type of acceptable child content. The default implementation of this method returns True if the factory kind is 'texture'.

IsReference()

Query whether or not the content or any of its ancestors is a reference content.

IsRenderHashCached()

This method is deprecated and no longer called. For more information see CalculateRenderHash

LoadFromFile(String filename)

Loads content from a library file. Does not add the content to the document. Use RhinoDoc.RenderMaterials.Add or similar.

MakeCopy()

Create a copy of the render content. All content is the same, except for the instance Id.

MakeGroupInstance()

Create an 'instance' of the content hierarchy and group the new hierarchy with this hierarchy. 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 hierarchy. \note The grouping will have no effect until the new instance is attached to the same document.

MatchData(RenderContent oldContent)

Implement to transfer data from another content to this content during creation.

ModifyRenderContentStyles(RenderContentStyles stylesToAdd, RenderContentStyles stylesToRemove)

ModifyRenderContentStyles

NewPreviewSceneServer(SceneServerData ssd)

Gets the PreviewSceneServer of the content

OnAddUserInterfaceSections()

Override to provide UI sections to display in the editor.

OnGetDefaultsInteractive()

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.

OnMakeCopy(ref RenderContent newContent)

Override this function to supplement the standard copying behavour for your RenderContent.

OpenInEditor()

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.

OpenInModalEditor()

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.

ParamNameFromChildSlotName(String childSlotName)

RegisterContent(PlugIn plugin)

Call RegisterContent in your plug-in's OnLoad function in order to register all of the custom RenderContent classes in your assembly.

RegisterContent(Assembly assembly,Guid pluginId)

Call RegisterContent in your plug-in's OnLoad function in order to register all of the custom RenderContent classes in your assembly.

RenderHashExclude(CrcRenderHashFlags flags, string excludeParameterNames, LinearWorkflow lw)

As RenderHash, but allows you to specify flags and exclude specific parameters. 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.

RenderHashExclude(CrcRenderHashFlags flags, string excludeParameterNames)

As RenderHash, but allows you to specify flags and exclude specific parameters.

RenderHashExclude(TextureRenderHashFlags flags, string excludeParameterNames)

This method is deprecated in favor of the one that takes CrcRenderHashFlags.

Replace(RenderContent newcontent)

SaveToFile(String filename, EmbedFilesChoice embedFilesChoice)

Saves content to a file - RMTL, RENV or RTEX.

SetChild(RenderContent renderContent,String childSlotName, ChangeContexts changeContexts)

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.

SetChild(RenderContent renderContent,String childSlotName)

SetChildSlotAmount(String childSlotName, double amount, ChangeContexts cc)

Sets the amount property for the texture in the specified child slot.

SetChildSlotOn(String childSlotName, bool bOn, ChangeContexts cc)

Sets the on-ness property for the texture in the specified child slot.

SetChildSlotParameter(String contentParameterName,String extraRequirementParameter, object value, ExtraRequirementsSetContexts sc)

Extra requirements are a way of specifying extra functionality on parameters in the automatic UI. Override this function to support values being set from automatic UI sections or the texture summary. See IAutoUIExtraRequirements.h in the C++ RDK SDK for string definitions for the parameter names. Call the base class from your override if you do not support the extra requirement parameter. Please do not call this function. It is only retained for backward compatibility. You should instead call SetExtraRequirementParameter().

SetExtraRequirementParameter(string contentParameterName, string extraRequirementParameter, object value, ExtraRequirementsSetContexts sc)

Extra requirements are a way of specifying extra functionality on parameters in the automatic UI. See IAutoUIExtraRequirements.h in the C++ RDK SDK for string definitions for the parameter names.

SetIsRenderHashRecursive(bool recursive)

By default, RenderHash recurses into children when computing the render hash. However, some applications may require children to be excluded from the render hash calculation. Call this method to enable or disable recursing into children. see RenderHash

SetName(string name, bool renameEvents, bool ensureNameUnique)

Set instance name for this content

SetParameter(String parameterName, object value, ChangeContexts changeContext)

Set the named parameter value for this content instance. If you do not support this parameter, call the base class.

SetParameter(String parameterName, object value)

Set the named parameter value for this content instance. If you do not support this parameter, call the base class.

SetRenderHash(uint hash)

This method is deprecated and no longer called. For more information see CalculateRenderHash

SmartUngroupRecursive()

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.

Ungroup()

Remove this content from any instance group it may be a member of. Does not record undo but does send the OnContentGroupIdChanged event.

UngroupRecursive()

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.

Uninitialize()

UseCount()

UseCount returns how many times the content is used

VirtualIcon(Size size, out Bitmap bitmap)

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.

Events (11)

ContentAdded

Used to monitor render content addition to the document.

ContentChanged

Used to monitor render content modifications.

ContentDeleted

Used to monitor render content deletion from the document.

ContentDeleting

Used to monitor render content deletion from the document.

ContentFieldChanged

This event is raised when a field value is modified.

ContentRenamed

Used to monitor render content renaming in the document.

ContentReplaced

Used to monitor render content replacing in the document.

ContentReplacing

Used to monitor render content replacing in the document.

ContentUpdatePreview

Used to monitor render content preview updates.

CurrentEnvironmentChanged

Event fired when changes to current environments have been made. This will be one of Background, Reflection or Skylighting Since 6.11

PreviewRendered

This event is raised when a preview has been rendered

Nothing found