RenderSettings

RenderSettings class

Contains settings used in rendering.

Inheritence: Rhino.Runtime.CommonObjectRenderSettings
Derived Classes:

Namespace: Rhino.Render
RenderSettings: references

Constructors (4)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

RenderSettings()

Initialize a new instance of the RenderSettings class.

RenderSettings(RenderSettings source)

Initialize new instance of the RenderSettings class.

Properties (40)

AmbientLight

Gets or sets the ambient light color used in rendering.

AntialiasLevel

Gets or sets anti-alias level, used for render quality

BackgroundColorBottom

Gets or sets the background bottom color used in rendering.

BackgroundColorTop

Gets or sets the background top color used in rendering.
Sets also the background color if a solid background color is set.

BackgroundStyle

How the viewport's background should be filled.

DepthCue

Gets or sets a value indicating whether to render using depth cues.
These are clues to help the perception of position and orientation of objects in the image.

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

Dithering

If this object is associated with a document, this gets the document dithering. If this object is associated with a File3dm, this gets the File3dm's dithering. Otherwise it gets a 'free-floating' dithering object.

FlatShade

Gets or sets a value indicating whether to render using flat shading.

GroundPlane

If this object is associated with a document, this gets the document ground plane. If this object is associated with a File3dm, this gets the File3dm's ground plane. Otherwise it gets a 'free-floating' ground plane object.

HasUserData

Gets True if this class has any custom information attached to it through UserData.

ImageDpi

Number of dots/inch (dots=pixels) to use when printing and saving bitmaps. The default is 72.0 dots/inch.

ImageSize

Gets or sets a value indicating the size of the rendering result if UseViewportSize is set to false. If UseViewportSize is set to true, then this value is ignored.

ImageUnitSystem

unit system to use when converting image pixel size and DPI information into a print size. Default = inches

IsDocumentControlled

If True this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.

IsValid

Tests an object to see if it is valid.

LinearWorkflow

If this object is associated with a document, this gets the document linear workflow. If this object is associated with a File3dm, this gets the File3dm's linear workflow. Otherwise it gets a 'free-floating' linear workflow object.

NamedView

Get or set the given named view

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

PostEffects

If this object is associated with a document, this gets the document post effect data collection. If this object is associated with a File3dm, this gets the File3dm's post effect data collection. Otherwise it gets a 'free-floating' post effect data collection object.

RenderAnnotations

Gets or sets a value indicating whether to instruct the rendering engine to show annotations, such as linear dimensions or angular dimensions.

RenderBackfaces

Gets or sets a value indicating whether to render back faces.

RenderChannels

If this object is associated with a document, this gets the document render channels. Otherwise it gets a 'free-floating' render channels object.

RenderCurves

Gets or sets a value indicating whether to instruct the rendering engine to show curves.

RenderIsoparams

Gets or sets a value indicating whether to instruct the rendering engine to show isocurves.

RenderMeshEdges

Gets or sets a value indicating whether to instruct the rendering engine to show mesh edges.

RenderPoints

Gets or sets a value indicating whether to instruct the rendering engine to show points.

RenderSource

Gets or sets the render source <b>RenderingSources</b> enumeration.

SafeFrame

If this object is associated with a document, this gets the document safe-frame. If this object is associated with a File3dm, this gets the File3dm's safe-frame. Otherwise it gets a 'free-floating' safe-frame object.

ScaleBackgroundToFit

Gets or sets a value indicating whether to scale the wallpaper in the background or not. This is meaningful only if the viewport has a wallpaper and render settings are set to render Wallpaper into the background.

ShadowmapLevel

0=none, 1=normal, 2=best.

Skylight

If this object is associated with a document, this gets the document skylight. If this object is associated with a File3dm, this gets the File3dm's skylight. Otherwise it gets a 'free-floating' skylight object.

Snapshot

Set or get the given snapshot view

SpecificViewport

Set or get the given specific viewport

Sun

If this object is associated with a document, this gets the document sun. If this object is associated with a File3dm, this gets the File3dm's sun. Otherwise it gets a 'free-floating' sun object.

TransparentBackground

Gets or sets whether rendering should be done with transparent background.

UseHiddenLights

Gets or sets a value indicating whether to render using lights that are on layers that are off.

UserData

List of custom information that is attached to this class.

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

UseViewportSize

Gets or sets a value indicating whether to use the resolution of the viewport being rendered or ImageSize when rendering

Methods (19)

ConstructConstObject(Object parentObject,Int32 subobjectIndex)

Assigns a parent object and a sub-object index to this.

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(Boolean disposing)

For derived class implementers.
This method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.
Also, you must call the base virtual method within your overriding method.

Duplicate()

Makes a free-floating copy of the object.

EnsurePrivateCopy()

If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.

FromBase64String(Int32 archive3dm,Int32 opennurbs,String base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(String json)

Create a CommonObject instance from a JSON string

GetObjectData(SerializationInfo info,StreamingContext context)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

IsValidWithLog(String log)

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

RenderEnvironment(EnvironmentUsage usage, EnvironmentPurpose purpose)

Get the render environment for a particular usage. Only works if this render settings is in a document. If usage is Background and the background mode is set to 'Solid Color' or 'Gradient' (i.e., not 'Environment'), then None will be returned.

RenderEnvironmentId(EnvironmentUsage usage, EnvironmentPurpose purpose)

Get the id of the render environment for a particular usage. If usage is Background and the background mode is set to 'Solid Color' or 'Gradient' (i.e., not 'Environment'), then Guid.Empty will be returned.

RenderEnvironmentOverride(EnvironmentUsage usage)

For usage background, this checks if the background style is set to 'Environment'. For reflection and skylighting, it checks if the relevant custom override is enabled.

SetRenderEnvironment(EnvironmentUsage usage, RenderEnvironment env)

Set the render environment for a particular usage. Passing None for usage Skylighting or Reflection will turn the override for that usage off.

SetRenderEnvironmentId(EnvironmentUsage usage,Guid guid)

Set the id of the render environment for a particular usage. Passing Guid.Empty for usage Skylighting or Reflection will turn the override for that usage off.

SetRenderEnvironmentOverride(EnvironmentUsage usage,Boolean on)

Set the given environment override on/off. Only works for usage Reflection and Skylighting.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

Nothing found