Properties

CanBeEdited

Determines if the content can be edited.
public bool CanBeEdited { get; }
inherited fromRenderContent

Category

Category for this content.
public string Category { get; }
inherited fromRenderContent

ChildSlotDisplayName

Returns the localized display name of the child slot name
public string ChildSlotDisplayName { get; }
inherited fromRenderContent

ChildSlotName

public string ChildSlotName { get; set; }
inherited fromRenderContent

CppPointer

public nint CppPointer { get; }
inherited fromRenderContent

DisplayName

Display name for this content.
public string DisplayName { get; }
inherited fromRenderContent

Document

Obsolete. Do not use. You should use DocumentOwner instead.
public RhinoDoc Document { get; }
obsoleteUse DocumentOwner
inherited fromRenderContent

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.
public RhinoDoc DocumentAssoc { get; set; }
inherited fromRenderContent

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.
public RhinoDoc DocumentOwner { get; }
inherited fromRenderContent

DocumentRegistered

Obsolete. Do not use. You should use DocumentOwner instead.
public RhinoDoc DocumentRegistered { get; }
obsoleteUse DocumentOwner
inherited fromRenderContent

Fields

Rhino.Render.Fields FieldDictionary which provides access to setting and retrieving field values.
public FieldDictionary Fields { get; }
inherited fromRenderContent

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
public virtual string Filename { get; set; }
inherited fromRenderContent

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.
public virtual IEnumerable<string> FilesToEmbed { get; }
inherited fromRenderContent

FirstChild

Return First child of this content or null if none.
public RenderContent FirstChild { get; }
inherited fromRenderContent

GroupId

Group ID of the content
public Guid GroupId { get; set; }
inherited fromRenderContent

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.
public bool Hidden { get; set; }
inherited fromRenderContent

Id

Instance identifier for this content.
public Guid Id { get; set; }
inherited fromRenderContent

IsDefaultInstance

Checks if render content is default instance.
public bool IsDefaultInstance { get; }
inherited fromRenderContent

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.
public bool IsHiddenByAutoDelete { get; }
inherited fromRenderContent

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.
public bool IsLocked { get; set; }
inherited fromRenderContent
ExceptionIsLocked must be called prior to adding content to the document

LocalMappingTransform

#Since v5.1
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.)
public Transform LocalMappingTransform { get; }

ModelUnits

Units used by this instance on length fields.
public LengthUnit ModelUnits { get; }
inherited fromRenderContent

Name

Instance 'raw' name for this content.
public string Name { get; set; }
inherited fromRenderContent

NextSibling

Return First sibling of this content or null if none.
public RenderContent NextSibling { get; }
inherited fromRenderContent

Notes

Notes for this content.
public string Notes { get; set; }
inherited fromRenderContent

Parent

Returns the top content in this parent/child chain.
public RenderContent Parent { get; }
inherited fromRenderContent

PixelSize2

#Since v7.6
Override to provide details on the actual pixel sizes of this texture in UVW directions return null if the texture should not be treated as a bitmap.
public virtual (int width, int height, int depth)? PixelSize2 { get; }

Private

The Content type should not be shown in the UI if Private is true
public bool Private { get; }
inherited fromRenderContent

ProxyType

Gets the proxy type of the render content
public ProxyTypes ProxyType { get; }
inherited fromRenderContent

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 RenderContent.CalculateRenderHash(ulong) method to provide a custom hash value.
[CLSCompliant(false)] public uint RenderHash { get; }
inherited fromRenderContent

RenderHashWithoutLocalMapping

#Since v6.0
Render hash for texture excluding local mapping.
[CLSCompliant(false)] public uint RenderHashWithoutLocalMapping { get; }

RenderHashWithoutLocalMappingOrLinearWorkflow

#Since v8.0
Render hash for texture excluding local mapping and linear workflow.
[CLSCompliant(false)] public uint RenderHashWithoutLocalMappingOrLinearWorkflow { get; }

Tags

Tags for this content.
public string Tags { get; set; }
inherited fromRenderContent

TopLevel

Returns true if this content has no parent, false if it is the child of another content.
public bool TopLevel { get; }
inherited fromRenderContent

TopLevelParent

Returns the top content in this parent/child chain.
public RenderContent TopLevelParent { get; }
inherited fromRenderContent

TypeDescription

Description for your content type. i.e., "Procedural checker pattern"
public abstract string TypeDescription { get; }
inherited fromRenderContent

TypeId

Type identifier for this content
public Guid TypeId { get; }
inherited fromRenderContent

TypeName

Name for your content type. i.e., "My .net Texture"
public abstract string TypeName { get; }
inherited fromRenderContent

Xml

public string Xml { get; }
inherited fromRenderContent

Methods

AddAutomaticUserInterfaceSection

Add a new automatic user interface section, Field values which include prompts will be automatically added to this section.
public bool AddAutomaticUserInterfaceSection(
caption,
Expandable tab caption.
id
Tab id which may be used later on to reference this tab.
)
inherited fromRenderContent
Returns true if the automatic tab section was added otherwise; returns false on error.

AddChild

public bool AddChild(
renderContent,
childSlotName
)
obsoleteThis method is obsolete and simply calls SetChild
Obsoleteinherited fromRenderContent

AddChild

public bool AddChild(
renderContent
)
obsoleteThis method is obsolete and simply calls SetChild
Obsoleteinherited fromRenderContent

AddUserInterfaceSection

public bool AddUserInterfaceSection()
inherited fromRenderContent

AddUserInterfaceSection

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.
public UserInterfaceSection AddUserInterfaceSection(
classType,
The control class to create and embed as a child window in the expandable tab client area. This class type must be derived from IWin32Window or this method will throw an ArgumentException. Implement the IUserInterfaceSection interface in your classType to get UserInterfaceSection notification.
caption,
Expandable tab caption.
createExpanded,
If this value is true then the new expandable tab section will initially be expanded, if it is false it will be collapsed.
createVisible
If this value is true then the new expandable tab section will initially be visible, if it is false it will be hidden.
)
obsoleteUse AddUserInterfaceSection(Rhino.UI.Controls.ICollapsibleSection) below instead. This function will not work on the Mac and is not type-safe.
Obsoleteinherited fromRenderContent
Returns the UserInterfaceSection object used to manage the new user control object.

BeginChange

Begins a change or batch of changes. It may also make a copy of the content state allowing RenderContent.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.
public void BeginChange(
changeContext
the change context. If this is ChangeContexts.UI, ChangeContexts.Program,ChangeContexts.Drop or ChangeContexts.Tree, the content will be copied. EndChange() will then send the copy as 'old' in the OnContentChanged event. RenderContent.EndChange() RenderContent.ContentChanged
)
inherited fromRenderContent

BeginCreateDynamicFields

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().
public void BeginCreateDynamicFields(
automatic
automatic specifies if the dynamic fields are automatic. If so, they will be created automatically during loading of the document.
)
inherited fromRenderContent

BindParameterToField

Use bindings to automatically wire parameters to fields
public void BindParameterToField(
parameterName,
Field
field,
setEvent
)
inherited fromRenderContent

BindParameterToField

Use bindings to automatically wire parameters to fields
public void BindParameterToField(
parameterName,
childSlotName,
Field
field,
setEvent
)
inherited fromRenderContent

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.
[CLSCompliant(false)] protected virtual uint CalculateRenderHash(
rcrcFlags
)
obsoleteUse CalculateRenderHash2
inherited fromRenderContent

CalculateRenderHash2

[CLSCompliant(false)] protected virtual uint CalculateRenderHash2(
flags,
excludeParameterNames
)
inherited fromRenderContent

ChangeChild

public bool ChangeChild(
oldContent,
newContent
)
obsoleteThis method is obsolete and simply calls SetChild
Obsoleteinherited fromRenderContent

ChildSlotAmount

Gets the amount property for the texture in the specified child slot.
public double ChildSlotAmount(
childSlotName
The child slot name of the texture.
)
inherited fromRenderContent
The requested amount value. Values are typically from 0.0 to 100.0

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".
public string ChildSlotNameFromParamName(
paramName
The name of a parameter field. Since child textures will usually correspond with some parameter (they generally either replace or modify a parameter over UV space) these functions are used to specify which parameter corresponded with child slot. If there is no correspondence, return the empty string.
)
inherited fromRenderContent
The default behavior for these functions is to return the input string. Sub-classes may (in the future) override these functions to provide different mappings.

ChildSlotOn

Gets the on-ness property for the texture in the specified child slot.
public bool ChildSlotOn(
childSlotName
The child slot name of the texture.
)
inherited fromRenderContent
true if successful, else false.

ConvertUnits

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.
public virtual void ConvertUnits()
inherited fromRenderContent

ConvertUnits

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.
[EditorBrowsable(EditorBrowsableState.Never)] public virtual void ConvertUnits()
obsolete. Use ConvertUnits with LengthUnit instead, and don't override this virtual function
Obsoleteinherited fromRenderContent

CreateDynamicField

Create a dynamic field with an initial value and min and max limits.
public bool CreateDynamicField(
internalName,
is the internal name of the field. Not localized.
localName,
is the localized user-friendly name of the field.
englishName,
is the English user-friendly name of the field.
value,
is the initial value of the field.
minValue,
is the minimum value of the field. Must be the same type as vValue.
maxValue,
is the maximum value of the field. Must be the same type as vValue.
sectionId
is used for filtering fields between sections. Zero if not needed.
)
inherited fromRenderContent

CreateEvaluator

#Since v5.1 Obsolete v6.0
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.
public virtual TextureEvaluator CreateEvaluator()
obsoleteUse version that takes TextureEvaluatorFlags enum
A texture evaluator instance.

CreateEvaluator

#Since v6.0
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.
public virtual TextureEvaluator CreateEvaluator(
evaluatorFlags
)
A texture evaluator instance.

DeleteAllChildren

public void DeleteAllChildren(
changeContexts
)
inherited fromRenderContent

DeleteChild

public bool DeleteChild(
childSlotName,
changeContexts
)
inherited fromRenderContent

Dispose

public void Dispose()
inherited fromRenderContent

Dispose

Dispose
protected virtual void Dispose(
disposing
)
inherited fromRenderContent

DynamicIcon

public virtual bool DynamicIcon(
size,
out Bitmap
bitmap,
usage
)
inherited fromRenderContent

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.
public RenderContent Edit()
inherited fromRenderContent
Returns an edited version of the content hierarchy if successful, else null. The method always edits the entire hierarchy. It places a copy of the hierarchy in the editor and selects the copied item that corresponds to this one. Therefore, editing a child will return a top-level render content, not a child.

EndChange

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

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().
public void EndCreateDynamicFields()
inherited fromRenderContent

FindChild

public RenderContent FindChild(
childSlotName
)
inherited fromRenderContent

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.
public RenderContent ForDisplay()
inherited fromRenderContent
The render content.

GenerateTextureSimulation

#Since v8.0
public virtual bool GenerateTextureSimulation()

GetChildSlotParameter

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().
public virtual object GetChildSlotParameter(
contentParameterName,
The parameter or field internal name to which this query applies.
extraRequirementParameter
The extra requirement parameter, as listed in IAutoUIExtraRequirements.h in the C++ RDK SDK.
)
inherited fromRenderContent
The value of the requested extra requirement parameter or null if the parameter does not exist. Current supported return values are (int, bool, float, double, string, Guid, Color, Vector3d, Point3d, DateTime).

GetDisplayInViewport

#Since v5.7
public bool GetDisplayInViewport()

GetEmbeddedFilesList

public string[] GetEmbeddedFilesList()
inherited fromRenderContent

GetEnvironmentMappingMode

#Since v5.7
public TextureEnvironmentMappingMode GetEnvironmentMappingMode()

GetEnvironmentMappingProjection

#Since v5.7
public static bool GetEnvironmentMappingProjection(
mode,
reflectionVector,
out float
u,
out float
v
)

GetExtraRequirementParameter

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.
public object GetExtraRequirementParameter(
contentParameterName,
The parameter or field internal name to which this query applies.
extraRequirementParameter
The extra requirement parameter, as listed in IAutoUIExtraRequirements.h in the C++ RDK SDK.
)
inherited fromRenderContent
The value of the requested extra requirement parameter or null if the parameter does not exist. Current supported return values are (int, bool, float, double, string, Guid, Color, Vector3d, Point3d, DateTime).

GetInternalEnvironmentMappingMode

#Since v5.7
public TextureEnvironmentMappingMode GetInternalEnvironmentMappingMode()

GetLocalMappingType

#Since v6.3
[CLSCompliant(false)] public RenderTexture.eLocalMappingType GetLocalMappingType()

GetMappingChannel

#Since v5.7
public virtual int GetMappingChannel()

GetOffset

#Since v5.7
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.
public virtual Vector3d GetOffset()

GetOffsetLocked

#Since v5.7
public virtual bool GetOffsetLocked()

GetParameter

Query the content instance for the value of a given named parameter. If you do not support this parameter, call the base class.
[CLSCompliant(false)] public virtual object GetParameter(
parameterName
Name of the parameter
)
inherited fromRenderContent
IConvertible. Note that you can't directly cast from object, instead you have to use the Convert mechanism.

GetPreviewIn3D

#Since v5.7
public virtual bool GetPreviewIn3D()

GetPreviewLocalMapping

#Since v5.7
public bool GetPreviewLocalMapping()

GetProceduralAaltonenNoiseArrayPointer

#Since v8.0
public static nint GetProceduralAaltonenNoiseArrayPointer()

GetProceduralAaltonenNoiseArraySize

#Since v8.0
[CLSCompliant(false)] public static uint GetProceduralAaltonenNoiseArraySize()

GetProceduralImpulseNoiseArrayPointer

#Since v8.0
public static nint GetProceduralImpulseNoiseArrayPointer()

GetProceduralImpulseNoiseArraySize

#Since v8.0
[CLSCompliant(false)] public static uint GetProceduralImpulseNoiseArraySize()

GetProceduralPerlinNoiseArrayPointer

#Since v8.0
public static nint GetProceduralPerlinNoiseArrayPointer()

GetProceduralPerlinNoiseArraySize

#Since v8.0
[CLSCompliant(false)] public static uint GetProceduralPerlinNoiseArraySize()

GetProceduralVcNoiseArrayPointer

#Since v8.0
public static nint GetProceduralVcNoiseArrayPointer()

GetProceduralVcNoiseArraySize

#Since v8.0
[CLSCompliant(false)] public static uint GetProceduralVcNoiseArraySize()

GetProjectionMode

#Since v5.7
public virtual TextureProjectionMode GetProjectionMode()

GetRepeat

#Since v5.7
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.
public virtual Vector3d GetRepeat()

GetRepeatLocked

#Since v5.7
public virtual bool GetRepeatLocked()

GetRotation

#Since v5.7
public virtual Vector3d GetRotation()

GetUiHash

This allows a content to have more than one UI for the same content type.
[CLSCompliant(false)] public virtual ulong GetUiHash()
inherited fromRenderContent
Default is zero and is ignored.

GetUnderlyingInstances

public bool GetUnderlyingInstances()
inherited fromRenderContent

GetWcsBoxMapping

#Since v5.7
public static Point3d GetWcsBoxMapping(
worldXyz,
normal
)

GetWrapType

#Since v5.7
public virtual TextureWrapType GetWrapType()

GraphInfo

#Since v6.3
public void GraphInfo()

Icon

public virtual bool Icon(
size,
out Bitmap
bitmap
)
inherited fromRenderContent

Initialize

public bool Initialize()
obsoleteThis method should not be called.
Obsoleteinherited fromRenderContent

IsCompatible

public virtual bool IsCompatible(
renderEngineId
)
inherited fromRenderContent

IsContentTypeAcceptableAsChild

public virtual bool IsContentTypeAcceptableAsChild(
type,
childSlotName
)
inherited fromRenderContent

IsFactoryProductAcceptableAsChild

public virtual bool IsFactoryProductAcceptableAsChild(
factory,
childSlotName
)
inherited fromRenderContent

IsFactoryProductAcceptableAsChild

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'.
public virtual bool IsFactoryProductAcceptableAsChild(
kindId,
factoryKind,
childSlotName
)
inherited fromRenderContent
Return true only if content with the specified kindId can be accepted as a child in the specified child slot.

IsHdrCapable

#Since v5.7
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.
public bool IsHdrCapable()

IsImageBased

#Since v6.0
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
public virtual bool IsImageBased()
true if the texture is image-based.

IsLinear

#Since v6.0
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.
public virtual bool IsLinear()

IsNormalMap

#Since v6.16
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.
public bool IsNormalMap()

IsReference

Query whether or not the content or any of its ancestors is a reference content.
public bool IsReference()
inherited fromRenderContent
true if the content is a reference, else false

IsRenderHashCached

This method is deprecated and no longer called. For more information see RenderContent.CalculateRenderHash(ulong)
public bool IsRenderHashCached()
obsoleteThis method is deprecated and no longer called. For more information see CalculateRenderHash
Obsoleteinherited fromRenderContent
bool

MakeCopy

Create a copy of the render content. All content is the same, except for the instance Id.
public RenderContent MakeCopy()
inherited fromRenderContent
The new RenderContent

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.
public RenderContent MakeGroupInstance()
inherited fromRenderContent
A grouped instance of the content hierarchy.

MatchData

Implement to transfer data from another content to this content during creation.
public virtual RenderContent.MatchDataResult MatchData(
oldContent
An old content object from which the implementation may harvest data.
)
inherited fromRenderContent
Information about how much data was matched.

ModifyRenderContentStyles

ModifyRenderContentStyles
protected void ModifyRenderContentStyles(
stylesToAdd,
stylesToRemove
)
inherited fromRenderContent

NewBitmapTexture

#Since v7.0
Constructs a new basic texture from a Bitmap.
public static RenderTexture NewBitmapTexture(
bitmap,
The bitmap to create the basic texture from.
doc
The document to associate the texture with.
)
Remarks: The returned bitmap texture holds a copy of 'bitmap'.
A new render texture.

NewBitmapTexture

#Since v6.4
Constructs a new basic texture from a SimulatedTexture.
public static RenderTexture NewBitmapTexture(
texture,
The texture to create the basic texture from.
doc
The document to associate the texture with.
)
A new render texture.

NewBitmapTexture

#Since v5.3 Obsolete v6.4
Constructs a new basic texture from a SimulatedTexture.
public static RenderTexture NewBitmapTexture(
texture
The texture to create the basic texture from.
)
A new render texture.

NewPreviewSceneServer

Gets the PreviewSceneServer of the content
public PreviewSceneServer NewPreviewSceneServer(
ssd
SceneServerData
)
inherited fromRenderContent

OnAddUserInterfaceSections

Override to provide UI sections to display in the editor.
protected virtual void OnAddUserInterfaceSections()
inherited fromRenderContent

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.
protected virtual bool OnGetDefaultsInteractive()
inherited fromRenderContent
If true is returned the content is created otherwise the creation is aborted.

OnMakeCopy

Override this function to supplement the standard copying behavour for your RenderContent.
protected virtual void OnMakeCopy(
newContent
Is the content that will be returned from MakeCopy.
)
inherited fromRenderContent

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.
public bool OpenInEditor()
inherited fromRenderContent
Returns true on success or false on error.

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.
public bool OpenInModalEditor()
obsoleteObsolete, use Edit a version that returns a RenderContent
Obsoleteinherited fromRenderContent
Returns true on success or false on error.

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".
public string ParamNameFromChildSlotName(
childSlotName
The named of the child slot to receive the parameter name for.
)
inherited fromRenderContent
The default behavior for these functions is to return the input string. Sub-classes may (in the future) override these functions to provide different mappings.

PixelSize

#Since v6.0
Get the texture dimensions for the RenderTexture.
public void PixelSize(
out int
u,
width
out int
v,
height
out int
w
depth, used for 3D textures
)
PixelSize2

RenderHashExclude

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.
[CLSCompliant(false)] public uint RenderHashExclude(
flags,
Flags to finely control the render hash.
excludeParameterNames,
Semicolon-delimited string of parameter names to exclude.
lw
Linear Workflow to use.
)
inherited fromRenderContent
The render hash.

RenderHashExclude

As RenderHash, but allows you to specify flags and exclude specific parameters.
[CLSCompliant(false)] public uint RenderHashExclude(
flags,
Flags to finely control the render hash.
excludeParameterNames
Semicolon-delimited string of parameter names to exclude.
)
inherited fromRenderContent
The render hash.

RenderHashExclude

This method is deprecated in favor of the one that takes CrcRenderHashFlags.
[CLSCompliant(false)] public uint RenderHashExclude(
flags,
excludeParameterNames
)
Obsoleteinherited fromRenderContent

Replace

public bool Replace(
newcontent
)
inherited fromRenderContent

SaveAsImage

#Since v6.15
Save texture as image
public bool SaveAsImage(
FullPath,
The full path of the file
width,
Image width
height,
Image height
depth
Image depth
)
returns true if file was saved, otherwise false

SaveToFile

Saves content to a file - RMTL, RENV or RTEX.
public bool SaveToFile(
filename,
Full path to the file to be saved.
embedFilesChoice
)
inherited fromRenderContent
The loaded content or null if an error occurred.

SetChild

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.
public bool SetChild(
renderContent,
Child content to add to this content. If pChild is NULL, the function will fail. If pChild is already attached to a document, the function will fail. If pChild is already a child of this or another content, the function will fail.
childSlotName,
The name that will be assigned to this child slot. The child slot name cannot be an empty string. If it is, the function will fail.
changeContexts
)
obsoleteUse SetChild without ChangeContexts and Begin/EndChange
Obsoleteinherited fromRenderContent
Returns true if the content was added or the child slot with this name was modified otherwise; returns false.

SetChild

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.
public bool SetChild(
renderContent,
Child content to add to this content. If renderContent is null, the function will fail. If renderContent is already attached to a document, the function will fail. If renderContent is already a child of this or another content, the function will fail.
childSlotName
The name that will be assigned to this child slot. The child slot name cannot be an empty string. If it is, the function will fail.
)
inherited fromRenderContent
Returns true if the content was added or the child slot with this name was modified, otherwise returns false.

SetChildSlotAmount

Sets the amount property for the texture in the specified child slot.
public void SetChildSlotAmount(
childSlotName,
The child slot name of the texture.
amount,
The texture amount. Values are typically from 0.0 to 100.0
cc
The context of the change.
)
inherited fromRenderContent

SetChildSlotOn

Sets the on-ness property for the texture in the specified child slot.
public void SetChildSlotOn(
childSlotName,
The child slot name of the texture.
bOn,
Value for the on-ness property.
cc
Context of the change
)
inherited fromRenderContent

SetChildSlotParameter

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().
public virtual bool SetChildSlotParameter(
contentParameterName,
The parameter or field internal name to which this query applies.
extraRequirementParameter,
The extra requirement parameter, as listed in IAutoUIExtraRequirements.h in the C++ RDK SDK.
value,
The value to set this extra requirement parameter. You will typically use System.Convert to convert the value to the type you need.
sc
The context of this operation.
)
inherited fromRenderContent
true if successful, else false.

SetDisplayInViewport

#Since v5.7
public void SetDisplayInViewport(
value,
changeContext
)

SetDisplayInViewport

#Since v6.0
public void SetDisplayInViewport(
value
)

SetEnvironmentMappingMode

#Since v5.7
public void SetEnvironmentMappingMode()

SetEnvironmentMappingMode

#Since v6.0
public void SetEnvironmentMappingMode()

SetExtraRequirementParameter

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.
public bool SetExtraRequirementParameter(
contentParameterName,
The parameter or field internal name to which this query applies.
extraRequirementParameter,
The extra requirement parameter, as listed in IAutoUIExtraRequirements.h in the C++ RDK SDK.
value,
The value to set this extra requirement parameter. You will typically use System.Convert to convert the value to the type you need.
sc
The context of this operation.
)
inherited fromRenderContent
true if successful, else false.

SetGraphInfo

#Since v6.3
public void SetGraphInfo()

SetIsRenderHashRecursive

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 RenderContent.RenderHash
public void SetIsRenderHashRecursive(
recursive
)
inherited fromRenderContent

SetMappingChannel

#Since v5.7
public virtual void SetMappingChannel(
value,
changeContext
)

SetName

Set instance name for this content
public void SetName(
name,
renameEvents,
ensureNameUnique
)
inherited fromRenderContent

SetOffset

#Since v5.7
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.
public virtual void SetOffset(
value,
changeContext
)

SetOffsetLocked

#Since v5.7
public virtual void SetOffsetLocked(
value,
changeContext
)

SetParameter

Set the named parameter value for this content instance. If you do not support this parameter, call the base class.
public virtual bool SetParameter(
parameterName,
value,
changeContext
)
obsoleteUse SetParameter without ChangeContexts and Begin/EndChange
Obsoleteinherited fromRenderContent

SetParameter

Set the named parameter value for this content instance. If you do not support this parameter, call the base class.
public virtual bool SetParameter(
parameterName,
value
)
inherited fromRenderContent

SetPreviewIn3D

#Since v5.7
public virtual void SetPreviewIn3D(
value,
changeContext
)

SetPreviewLocalMapping

#Since v5.7
public void SetPreviewLocalMapping(
value,
changeContext
)

SetPreviewLocalMapping

#Since v6.0
public void SetPreviewLocalMapping(
value
)

SetProjectionMode

#Since v5.7
public virtual void SetProjectionMode()

SetRenderHash

This method is deprecated and no longer called. For more information see RenderContent.CalculateRenderHash(ulong)
[CLSCompliant(false)] public void SetRenderHash(
hash
)
obsoleteThis method is deprecated and no longer called. For more information see CalculateRenderHash
Obsoleteinherited fromRenderContent

SetRepeat

#Since v5.7
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.
public virtual void SetRepeat(
value,
changeContext
)

SetRepeatLocked

#Since v5.7
public virtual void SetRepeatLocked(
value,
changeContext
)

SetRotation

#Since v5.7
public virtual void SetRotation(
value,
changeContext
)

SetWrapType

#Since v5.7
public virtual void SetWrapType(
value,
changeContext
)

SimulatedTexture

#Since v6.0
public virtual SimulatedTexture SimulatedTexture(
TextureGeneration
tg,
size = -1,
obj = null
)

SimulateTexture

#Since v5.1 Obsolete v6.0
public virtual void SimulateTexture(
simulation,
isForDataOnly
)
obsoleteUse SimulateTexture with size, TextureGeneration and object instead

SimulateTexture

#Since v6.0
public virtual void SimulateTexture(
simulation,
TextureGeneration
tg,
size = -1,
obj = null
)

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.
public bool SmartUngroupRecursive()
inherited fromRenderContent
true if a content was ungrouped, \e false if no content or child was part of a group.

Ungroup

Remove this content from any instance group it may be a member of. Does not record undo but does send the OnContentGroupIdChanged event.
public bool Ungroup()
inherited fromRenderContent
true if content was ungrouped, \e false if it was not part of a group.

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.
public bool UngroupRecursive()
inherited fromRenderContent
true if a content was ungrouped, \e false if no content or child was part of a group.

Uninitialize

public void Uninitialize()
obsoleteThis method should not be called.
Obsoleteinherited fromRenderContent

UseCount

UseCount returns how many times the content is used
public int UseCount()
inherited fromRenderContent

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.
public virtual bool VirtualIcon(
size,
Requested icon size
out Bitmap
bitmap
)
inherited fromRenderContent
Return Icon to display in the content browser.