Rhino.Render

Classes

Class

Description

This class contains the event to add custom ui sections when the content ui is created.

Public Class
AddCustomUISectionsEventArgs

Used as Rhino.Render Custom Events args.

\ingroup rhino_render Inherit from AsyncRenderContext to be able to create asynchronous render engine implementations through RhinoCommon.

Public Class
CachedTextureCoordinates

Used for cached texture coordinates

Public Class
City

City

Public Class
ContentCollectionIterator

An iterator for the RenderContentCollection

Public Class
ContentUndoBlocker

Public Class
ContentUndoHelper

Content undo helper to be used with “using {}” to enclose a block of changes.

Public Class
ContentUuids

Content Guids of RenderContent provided by the RDK SDK. These Guids can be used to check against RenderContent.TypeId.

Public Class
ConvertibleExtensions

Extension methods for IConvertible that work when an object is a Variant.

Public Class
CreatePreviewEventArgs

Used in RenderPlugIn virtual CreatePreview function

Public Class
CreatePreviewEventArgs.SceneObject

Public Class
CreateTexture2dPreviewEventArgs

Public Class
CustomRenderContentAttribute

Attributes for RenderContent

Public Class
CustomRenderMeshProvider

Obsolete.

You must call CustomRenderMeshProvider.RegisterProviders() from your plug-ins OnLoad override for each assembly containing a custom mesh provider. Only publicly exported classes derived from CustomRenderMeshProvider with a public constructor that has no parameters will get registered.

Public Class
CustomRenderMeshProvider2

Obsolete.

Public Class
Decal

Represents a decal, or a picture that can be moved on an object.

Public Class
DecalCreateParams

Used by RhinoObject.AddDecal() to create and add a decal

Public Class
Decals

Represents all the decals of an object.

Public Class
Dithering

This is the interface to dithering settings.

Public Class
DocumentOrFreeFloatingBase

Base class for Rhino.Render objects that are owned by the document, or can be delivered separately from other functions. In general, you cannot create these objects yourself.

Public Class
FreeFloatingBase

Base class for Rhino.Render objects that are owned by the document, or can be delivered separately from other functions. In general, you cannot create these objects yourself.

Public Class
GroundPlane

Represents an infinite plane for implementation by renderers. See

SupportsFeature

Public Class
ImageFile

Controls interaction with RDK render image files

Public Class
ImageFileEventArgs

Public Class
LightArray

Public Class
LightManagerSupport

Base class for implementing custom light managers in .NET

Public Class
LightManagerSupportClient

Public Class
LinearWorkflow

This is the interface to linear workflow settings.

Public Class
MappingTag

Holds texture mapping information.

Public Class
MetaDataProxy

ProxyClass for MetaData

Public Class
NamedValue

Public Class
PhysicallyBasedMaterial

Obsolete.

Public Class
PhysicallyBasedMaterial.ParametersNames

Obsolete.

Helper class with fields containing the names of fields available in our PBR implementation.

Public Class
PixelBuffer

Public Class
PreviewAppearance

PreviewAppearance class

Public Class
PreviewBackground

PreviewBackGround takes care of construction and destruction of PreviewLight

Public Class
PreviewGeometry

PreviewAppearance takes care of construction and destruction of PreviewGeometry

Public Class
PreviewJobSignature

Preview Job Signature is a specific identifier for a specific rendered preview

Public Class
PreviewLighting

PreviewAppearance takes care of construction and destruction of PreviewLight

Public Class
PreviewRenderedEventArgs

PreviewRenderedEventArgs is raised when a content preview has been rendered

Public Class
PreviewSceneServer

PreviewSceneServer

Public Class
RdkUndo

RdkUndo class, which is used to get the RdkUndoRecord

Public Class
RdkUndoRecord

RdkUndoRecord class

Public Class
RealtimeDisplayMode

Base class for implementing real-time display modes in .NET. Pay special attention that in StartRenderer the RenderWindow.SetSize() function is called if the implementation relies on the RenderWindow to do the drawing to the viewport. If i.e. OpenGL is used to draw render results to the viewport then SetSize() doesn’t have to be called, nor should the implementation then access channels on the RenderWindow, as those then don’t exist. For OpenGL-based drawing the RenderWindow is used as a container for ViewInfo management, nothing else.

Public Class
RealtimeDisplayMode.DisplayPipelineSettingsChangedEventArgs

Public Class
RealtimeDisplayMode.DrawMiddlegroundEventArgs

Public Class
RealtimeDisplayMode.HudMaxPassesChangedEventArgs

Public Class
RealtimeDisplayMode.InitFramebufferEventArgs

Public Class
RealtimeDisplayModeClassInfo

Class information obligatory for registering RealtimeDisplayMode implementations.

Public Class
RenderChannels

Render Channels. This corresponds to the user’s settings in the Rendering panel.

Public Class
RenderContent

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

Public Class
RenderContentChangedEventArgs

EventArgs for the RenderContentChanged event

Public Class
RenderContentCollection

A collection of Render content

Public Class
RenderContentEventArgs

Event args for RenderContent

Public Class
RenderContentFieldChangedEventArgs

EventArgs for the RenderContentFieldChanged event

Public Class
RenderContentKindList

Models a collection of kinds.

Public Class
RenderContentManager

RenderContentManager’s RestoreRenderContents method unpacks the default render contents from the from the application and places them in the User’s folder. Only available on Mac at the moment.

Public Class
RenderContentSerializer

Used to import and export custom render content such as materials, environments and textures. You must override RenderPlugIn.RenderContentSerializers() and return an array of derived RenderContentSerializer class types to add to the content browsers.

Public Class
RenderContentType

Represents one of the render content types registered with Rhino.

Public Class
RenderEndEventArgs

Contains information about why OnRenderEnd was called

Public Class
RenderEnvironment

Public Class
RenderEnvironmentTable

Public Class
RenderMaterial

Public Class
RenderMaterial.BasicMaterialParameterNames

Parameter names for use in GetNamedParameter and SetNamedParameter with basic materials.

Public Class
RenderMaterialTable

Public Class
RenderPanels

This class is used to extend the standard Render user interface

Public Class
RenderPipeline

Provides facilities to a render plug-in for integrating with the standard Rhino render window. Also adds helper functions for processing a render scene. This is the suggested class to use when integrating a renderer with Rhino and maintaining a “standard” user interface that users will expect.

Public Class
RenderPlugInInfo

Public Class
RenderPlugInList

Public Class
RenderPrimitive

Public Class
RenderPrimitiveList

Obsolete.

Public Class
RenderPropertyChangedEvent

Used by Rhino.Render object property value has changed events.

Public Class
RenderSettings

Contains settings used in rendering.

Public Class
RenderSourceView

Helper class to get the correct view from the Render View Source settings. An instance of this class is supposed to be used with the using() {} construct.

Public Class
RenderTabs

Public Class
RenderTexture

Public Class
RenderTextureTable

Public Class
RenderWindow

Public Class
RenderWindow.Channel

Public Class
RenderWindow.ChannelGPU

Public Class
RenderWindow.ImageAdjust

Class to set image adjusting settings to a RenderWindow. This can’t be directly created. Instead, one should use RenderWindow.GetAdjust() to get an ImageAdjust instance that can be modified, then passed into RenderWindow.SetAdjust() to update image adjusting settings.1

Public Class
RenderWindowClonedEventArgs

Public Class
SafeFrame

Safe frame

Public Class
SceneServerData

The Scene Server Data used by the PreviewSceneServer

Public Class
SimulatedEnvironment

Public Class
SimulatedTexture

Public Class
Skylight

Public Class
Sun

Represents the Sun on a little portion of Earth.

Public Class
SupportOptions

Public Class
TexturedColor

Color4f specialization of TexturedValue.

Public Class
TexturedFloat

float specialization of TexturedValue.

Public Class
TexturedValue.T.

Generic class to help holding on to related values. This can be used to get data from textured content fields with the HandleTexturedValue function.

Public Class
TextureEvaluator

This is the interface to a lightweight object capable of evaluating texture color throughout uvw space. Derive from this class to create your own texture evaluator to return from a custom RenderTexture.

Public Class
TextureGraphInfo

Public Class
TextureMapping

Represents a texture mapping.

Public Class
TimeZone

TimeZone

Public Class
TwoColorRenderTexture

Public Class
UndoRedo

This class contains the event for UndoRedoChanged that is fired from RDK .

Public Class
Utilities