Click or drag to resize

RenderMaterial Class

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

Inheritance Hierarchy

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

The RenderMaterial type exposes the following members.

Constructors
  NameDescription
Protected methodRenderMaterial
Initializes a new instance of the RenderMaterial class
Top
Properties
  NameDescription
Public propertyCanBeEdited
Determines if the content can be edited.
(Inherited from RenderContent.)
Public propertyCategory
Category for this content.
(Inherited from RenderContent.)
Public propertyChildSlotName (Inherited from RenderContent.)
Public propertyCppPointer (Inherited from RenderContent.)
Public propertyDefaultPreviewBackgroundType
Set or get the default scene background for the image that appears in preview panes
Public propertyDefaultPreviewGeometryType
Set or get the default geometry that appears in preview panes
Public propertyDefaultPreviewSize
The default preview geometry size
Public propertyDocument
If this content is in a document content list, the document will be returned. Otherwise null.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public propertyFields
Rhino.Render.Fields FieldDictionary which provides access to setting and retrieving field values.
(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 nullptr if none.
(Inherited from RenderContent.)
Public propertyStatic memberGemMaterialGuid
Public propertyStatic memberGlassMaterialGuid
Public propertyHidden
Determines if the content has the hidden flag set.
(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 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 propertyStatic memberMetalMaterialGuid
Public propertyName
Instance name for this content.
(Inherited from RenderContent.)
Public propertyNextSibling
Return First sibling of this content or nullptr if none.
(Inherited from RenderContent.)
Public propertyNotes
Notes for this content.
(Inherited from RenderContent.)
Public propertyStatic memberPaintMaterialGuid
Public propertyParent
Returns the top content in this parent/child chain.
(Inherited from RenderContent.)
Public propertyStatic memberPictureMaterialGuid
Public propertyStatic memberPlasterMaterialGuid
Public propertyStatic memberPlasticMaterialGuid
Public propertyProxyType
Gets the proxy type of the render content
(Inherited from RenderContent.)
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.
(Inherited from RenderContent.)
Public propertySmellsLikeGem
Public propertySmellsLikeGlass
Public propertySmellsLikeMetal
Public propertySmellsLikePaint
Public propertySmellsLikePlaster
Public propertySmellsLikePlastic
Public propertySmellsLikeTexturedGem
Public propertySmellsLikeTexturedGlass
Public propertySmellsLikeTexturedMetal
Public propertySmellsLikeTexturedPaint
Public propertySmellsLikeTexturedPlaster
Public propertySmellsLikeTexturedPlastic
Public propertyTags
Tags for this content.
(Inherited from RenderContent.)
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. ie. "Procedural checker pattern"
(Inherited from RenderContent.)
Public propertyTypeId
Type identifier for this content
(Inherited from RenderContent.)
Public propertyTypeName
Name for your content type. ie. "My .net Texture"
(Inherited from RenderContent.)
Public propertyXml (Inherited from RenderContent.)
Top
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 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 methodStatic memberCreateBasicMaterial(Material)
Constructs a new basic material from a Material.
Public methodStatic memberCreateBasicMaterial(Material, RhinoDoc)
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
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 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 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 methodGetTextureAmountFromUsage
Public methodGetTextureFromUsage
Public methodGetTextureOnFromUsage
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHandleTexturedValueT
Handle a textured content field. Values will be read into an instance of TexturedColor
Public methodIcon (Inherited from RenderContent.)
Public methodInitialize (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 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 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.)
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 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 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 methodSimulateMaterial(Boolean)
Override this function to provide a Rhino.DocObjects.Material definition for this material to be used by other rendering engines including the display.
Public methodSimulateMaterial(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.
Public methodTextureChildSlotName
Override this function to provide information about which texture is used for the standard (ie - defined in ON_Texture) texture channels.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUninitialize (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
Version Information

Rhino for Windows

Supported in: 6.14
See Also