Click or drag to resize

TwoColorRenderTexture Class

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

Inheritance Hierarchy

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public abstract class TwoColorRenderTexture : RenderTexture

The TwoColorRenderTexture type exposes the following members.

Constructors
  NameDescription
Protected methodTwoColorRenderTexture
Initializes a new instance of the TwoColorRenderTexture 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 propertyChildSlotDisplayName
Returns the localized display name of the child slot name
(Inherited from RenderContent.)
Public propertyChildSlotName (Inherited from RenderContent.)
Public propertyColor1
Public propertyColor2
Public propertyCppPointer (Inherited from RenderContent.)
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 propertyGroupId
Group ID of the content
(Inherited from RenderContent.)
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 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.
(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 propertyLocalMappingTransform
Gets the transformation that can be applied to the UVW vector to convert it from normalized texture space into locally mapped space (ie - with repeat, offset and rotation applied.)
(Inherited from RenderTexture.)
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 propertyParent
Returns the top content in this parent/child chain.
(Inherited from RenderContent.)
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 propertyRenderHashWithoutLocalMapping
Render hash for texture excluding local mapping.
(Inherited from RenderTexture.)
Public propertySuperSample
Public propertySwapColors
Public propertyTags
Tags for this content.
(Inherited from RenderContent.)
Public propertyTexture1Amount
Public propertyTexture1On
Public propertyTexture2Amount
Public propertyTexture2On
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
Protected methodAddAdditionalUISections
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 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 methodCreateEvaluator Obsolete.
Constructs a texture evaluator. This is an independent lightweight object capable of evaluating texture color throughout uvw space. May be called from within a rendering shade pipeline.
(Inherited from RenderTexture.)
Public methodCreateEvaluator(RenderTextureTextureEvaluatorFlags)
Constructs a texture evaluator. This is an independent lightweight object capable of evaluating texture color throughout uvw space. May be called from within a rendering shade pipeline.
(Inherited from RenderTexture.)
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 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 methodGetDisplayInViewport (Inherited from RenderTexture.)
Public methodGetEmbeddedFilesList (Inherited from RenderContent.)
Public methodGetEnvironmentMappingMode (Inherited from RenderTexture.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInternalEnvironmentMappingMode (Inherited from RenderTexture.)
Public methodGetLocalMappingType (Inherited from RenderTexture.)
Public methodGetMappingChannel (Inherited from RenderTexture.)
Public methodGetOffset
Get offset value across UVW space. If the projection type is WCS or other type specified in model units, then this is the offset in meters.
(Inherited from RenderTexture.)
Public methodGetOffsetLocked (Inherited from RenderTexture.)
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 methodGetPreviewIn3D (Inherited from RenderTexture.)
Public methodGetPreviewLocalMapping (Inherited from RenderTexture.)
Public methodGetProjectionMode (Inherited from RenderTexture.)
Public methodGetRepeat
Get repeat value across UVW space. If the projection type is WCS or other type specified in model units, then this is the repeat across 1 meter of the model.
(Inherited from RenderTexture.)
Public methodGetRepeatLocked (Inherited from RenderTexture.)
Public methodGetRotation
(Inherited from RenderTexture.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUnderlyingInstances (Inherited from RenderContent.)
Public methodGetWrapType (Inherited from RenderTexture.)
Public methodGraphInfo (Inherited from RenderTexture.)
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 methodIsHdrCapable
Return true if the texture is HDR capable. When creating a custom RenderTexture implementation that is HDR capable set the appropriate property on the CustomRenderContentAttribute decorator on that clas.
(Inherited from RenderTexture.)
Public methodIsImageBased
Query if the texture is image based. When creating a custom RenderTexture implementation of an image-based texture set the appropriate property on the CustomRenderContentAttribute decorator on that class. Do not override this function
(Inherited from RenderTexture.)
Public methodIsLinear
Return true if the texture color data is linear. NOTE: this function is marked as virtual, but the correct way to make a custom RenderTexture linear is by setting the correct property for the CustomRenderContentAttribute decorator on the class.
(Inherited from RenderTexture.)
Public methodIsNormalMap
Return true if the texture is a normalmap. When creating a custom RenderTexture implementation of a normal map set the appropriate property on the CustomRenderContentAttribute decorator on that clas.
(Inherited from RenderTexture.)
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 methodNewPreviewSceneServer
Gets the PreviewSceneServer of the content
(Inherited from RenderContent.)
Protected methodOnAddUserInterfaceSections (Overrides RenderContentOnAddUserInterfaceSections.)
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 methodPixelSize
Get the texture dimensions for the RenderTexture.
(Inherited from RenderTexture.)
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 methodSaveAsImage
Save texture as image
(Inherited from RenderTexture.)
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 methodSetDisplayInViewport(Boolean) (Inherited from RenderTexture.)
Public methodSetDisplayInViewport(Boolean, RenderContentChangeContexts) (Inherited from RenderTexture.)
Public methodSetEnvironmentMappingMode(TextureEnvironmentMappingMode) (Inherited from RenderTexture.)
Public methodSetEnvironmentMappingMode(TextureEnvironmentMappingMode, RenderContentChangeContexts) (Inherited from RenderTexture.)
Public methodSetGraphInfo (Inherited from RenderTexture.)
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 methodSetMappingChannel (Inherited from RenderTexture.)
Public methodSetName
Set instance name for this content
(Inherited from RenderContent.)
Public methodSetOffset
Set offset value across UVW space. If the projection type is WCS or other type specified in model units, then this is the offset in meters.
(Inherited from RenderTexture.)
Public methodSetOffsetLocked (Inherited from RenderTexture.)
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 methodSetPreviewIn3D (Inherited from RenderTexture.)
Public methodSetPreviewLocalMapping(Boolean) (Inherited from RenderTexture.)
Public methodSetPreviewLocalMapping(Boolean, RenderContentChangeContexts) (Inherited from RenderTexture.)
Public methodSetProjectionMode (Inherited from RenderTexture.)
Public methodSetRenderHash Obsolete.
This method is deprecated and no longer called. For more information see CalculateRenderHash(UInt64)
(Inherited from RenderContent.)
Public methodSetRepeat
Set repeat value across UVW space. If the projection type is WCS or other type specified in model units, then this is the repeat across 1 meter of the model.
(Inherited from RenderTexture.)
Public methodSetRepeatLocked (Inherited from RenderTexture.)
Public methodSetRotation (Inherited from RenderTexture.)
Public methodSetWrapType (Inherited from RenderTexture.)
Public methodSimulatedTexture (Inherited from RenderTexture.)
Public methodSimulateTexture(SimulatedTexture, Boolean) Obsolete. (Inherited from RenderTexture.)
Public methodSimulateTexture(SimulatedTexture, RenderTextureTextureGeneration, Int32, RhinoObject) (Inherited from RenderTexture.)
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 (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