RhinoCommon API
RenderMaterial Class |
[Missing <summary> documentation for "T:Rhino.Render.RenderMaterial"]

Namespace: Rhino.Render
Assembly: RhinoCommon (in RhinoCommon.dll)

The RenderMaterial type exposes the following members.

Name | Description | |
---|---|---|
![]() | RenderMaterial | Initializes a new instance of the RenderMaterial class |

Name | Description | |
---|---|---|
![]() | CanBeEdited |
Determines if the content can be edited.
(Inherited from RenderContent.) |
![]() | Category |
Category for this content.
(Inherited from RenderContent.) |
![]() | ChildSlotName | (Inherited from RenderContent.) |
![]() | CppPointer | (Inherited from RenderContent.) |
![]() | DefaultPreviewBackgroundType |
Set or get the default scene background for the image that appears in
preview panes
|
![]() | DefaultPreviewGeometryType |
Set or get the default geometry that appears in preview panes
|
![]() | DefaultPreviewSize |
The default preview geometry size
|
![]() | Document |
If this content is in a document content list, the document will be returned. Otherwise null.
(Inherited from RenderContent.) |
![]() | DocumentAssoc |
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.
(Inherited from RenderContent.) |
![]() | DocumentRegistered |
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.
(Inherited from RenderContent.) |
![]() | Fields |
Rhino.Render.Fields FieldDictionary which provides access to setting
and retrieving field values.
(Inherited from RenderContent.) |
![]() | 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.
(Inherited from RenderContent.) |
![]() | FirstChild |
Return First child of this content or nullptr if none.
(Inherited from RenderContent.) |
![]() ![]() | GemMaterialGuid | |
![]() ![]() | GlassMaterialGuid | |
![]() | Hidden |
Determines if the content has the hidden flag set.
(Inherited from RenderContent.) |
![]() | Id |
Instance identifier for this content.
(Inherited from RenderContent.) |
![]() | IsDefaultInstance |
Checks if render content is default instance.
(Inherited from RenderContent.) |
![]() | 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.
(Inherited from RenderContent.) |
![]() ![]() | MetalMaterialGuid | |
![]() | Name |
Instance name for this content.
(Inherited from RenderContent.) |
![]() | NextSibling |
Return First sibling of this content or nullptr if none.
(Inherited from RenderContent.) |
![]() | Notes |
Notes for this content.
(Inherited from RenderContent.) |
![]() ![]() | PaintMaterialGuid | |
![]() | Parent |
Returns the top content in this parent/child chain.
(Inherited from RenderContent.) |
![]() ![]() | PictureMaterialGuid | |
![]() ![]() | PlasterMaterialGuid | |
![]() ![]() | PlasticMaterialGuid | |
![]() | ProxyType |
Gets the proxy type of the render content
(Inherited from RenderContent.) |
![]() | RenderHash |
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.
(Inherited from RenderContent.) |
![]() | SmellsLikeGem | |
![]() | SmellsLikeGlass | |
![]() | SmellsLikeMetal | |
![]() | SmellsLikePaint | |
![]() | SmellsLikePlaster | |
![]() | SmellsLikePlastic | |
![]() | SmellsLikeTexturedGem | |
![]() | SmellsLikeTexturedGlass | |
![]() | SmellsLikeTexturedMetal | |
![]() | SmellsLikeTexturedPaint | |
![]() | SmellsLikeTexturedPlaster | |
![]() | SmellsLikeTexturedPlastic | |
![]() | Tags |
Tags for this content.
(Inherited from RenderContent.) |
![]() | TopLevel |
Returns true if this content has no parent, false if it is the child of another content.
(Inherited from RenderContent.) |
![]() | TopLevelParent |
Returns the top content in this parent/child chain.
(Inherited from RenderContent.) |
![]() | TypeDescription |
Description for your content type. ie. "Procedural checker pattern"
(Inherited from RenderContent.) |
![]() | TypeId |
Type identifier for this content
(Inherited from RenderContent.) |
![]() | TypeName |
Name for your content type. ie. "My .net Texture"
(Inherited from RenderContent.) |
![]() | Xml | (Inherited from RenderContent.) |

Name | Description | |
---|---|---|
![]() | AddAutomaticUserInterfaceSection |
Add a new automatic user interface section, Field values which include
prompts will be automatically added to this section.
(Inherited from RenderContent.) |
![]() | AddChild(RenderContent) | Obsolete. (Inherited from RenderContent.) |
![]() | AddChild(RenderContent, String) | Obsolete. (Inherited from RenderContent.) |
![]() | AddUserInterfaceSection(ICollapsibleSection) | (Inherited from RenderContent.) |
![]() | AddUserInterfaceSection(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.) |
![]() | BeginChange |
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.) |
![]() | BindParameterToField(String, Field, RenderContentChangeContexts) |
Use bindings to automatically wire parameters to fields
(Inherited from RenderContent.) |
![]() | BindParameterToField(String, String, Field, RenderContentChangeContexts) |
Use bindings to automatically wire parameters to fields
(Inherited from RenderContent.) |
![]() | CalculateRenderHash |
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.) |
![]() | ChangeChild | Obsolete. (Inherited from RenderContent.) |
![]() | ChildSlotAmount |
Gets the amount property for the texture in the specified child slot. Values are typically from 0.0 - 100.0
(Inherited from RenderContent.) |
![]() | ChildSlotNameFromParamName |
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.) |
![]() | ChildSlotOn |
Gets the on-ness property for the texture in the specified child slot.
(Inherited from RenderContent.) |
![]() ![]() | CreateBasicMaterial(Material) |
Constructs a new basic material from a Material.
|
![]() ![]() | CreateBasicMaterial(Material, RhinoDoc) | |
![]() | DeleteAllChildren | (Inherited from RenderContent.) |
![]() | DeleteChild | (Inherited from RenderContent.) |
![]() | Dispose | (Inherited from RenderContent.) |
![]() | Dispose(Boolean) | (Inherited from RenderContent.) |
![]() | DynamicIcon | (Inherited from RenderContent.) |
![]() | 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(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.) |
![]() | Equals | (Inherited from Object.) |
![]() | Finalize | (Inherited from RenderContent.) |
![]() | FindChild | (Inherited from RenderContent.) |
![]() | GetChildSlotParameter |
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.) |
![]() | GetEmbeddedFilesList | (Inherited from RenderContent.) |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetParameter |
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.) |
![]() | GetTextureAmountFromUsage | |
![]() | GetTextureFromUsage | |
![]() | GetTextureOnFromUsage | |
![]() | GetType | (Inherited from Object.) |
![]() | Icon | (Inherited from RenderContent.) |
![]() | Initialize | (Inherited from RenderContent.) |
![]() | IsCompatible | (Inherited from RenderContent.) |
![]() | IsContentTypeAcceptableAsChild | (Inherited from RenderContent.) |
![]() | IsFactoryProductAcceptableAsChild(ContentFactory, String) | (Inherited from RenderContent.) |
![]() | IsFactoryProductAcceptableAsChild(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.) |
![]() | IsRenderHashCached | Obsolete.
This method is deprecated and no longer called. For more information
see CalculateRenderHash(UInt64) (Inherited from RenderContent.) |
![]() | MakeCopy |
Create a copy of the render content. All content is the same, except for the
instance Id.
(Inherited from RenderContent.) |
![]() | MatchData |
Implement to transfer data from another content to this content during creation.
(Inherited from RenderContent.) |
![]() | MemberwiseClone | (Inherited from Object.) |
![]() | ModifyRenderContentStyles | (Inherited from RenderContent.) |
![]() | NewPreviewSceneServer |
Gets the PreviewSceneServer of the content
(Inherited from RenderContent.) |
![]() | OnAddUserInterfaceSections |
Override to provide UI sections to display in the editor.
(Inherited from RenderContent.) |
![]() | 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.
(Inherited from 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.
(Inherited from RenderContent.) |
![]() | 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.
(Inherited from RenderContent.) |
![]() | ParamNameFromChildSlotName |
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.) |
![]() | RenderHashExclude(CrcRenderHashFlags, String) |
As RenderHash, but ignore parameter names given.
(Inherited from RenderContent.) |
![]() | RenderHashExclude(TextureRenderHashFlags, String) |
As RenderHash, but ignore parameter names given.
(Inherited from RenderContent.) |
![]() | SetChild(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.) |
![]() | SetChild(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.) |
![]() | SetChildSlotAmount |
Sets the amount property for the texture in the specified child slot. Values are typically from 0.0 - 100.0
(Inherited from RenderContent.) |
![]() | SetChildSlotOn |
Sets the on-ness property for the texture in the specified child slot.
(Inherited from RenderContent.) |
![]() | SetChildSlotParameter |
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.) |
![]() | SetParameter(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.) |
![]() | SetParameter(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.) |
![]() | SetRenderHash | Obsolete.
This method is deprecated and no longer called. For more information
see CalculateRenderHash(UInt64) (Inherited from RenderContent.) |
![]() | SimulateMaterial(Boolean) |
Override this function to provide a Rhino.DocObjects.Material definition for this material
to be used by other rendering engines including the display.
|
![]() | SimulateMaterial(Material, Boolean) |
Override this function to provide a Rhino.DocObjects.Material definition for this material
to be used by other rendering engines including the display.
|
![]() | TextureChildSlotName |
Override this function to provide information about which texture is used for
the standard (ie - defined in ON_Texture) texture channels.
|
![]() | ToString | (Inherited from Object.) |
![]() | Uninitialize | (Inherited from RenderContent.) |
![]() | VirtualIcon |
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.) |

Rhino for Windows
Supported in: 6.8