RenderSettings

Public Class

Contains settings used in rendering.

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.Render.RenderSettings

Namespace: Rhino.Render

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class RenderSettings : CommonObject

The RenderSettings type exposes the following members.

Constructors

Name

Description

---

Public Method

RenderSettings.

Initialize a new instance of the RenderSettings class.

---

Public Method

RenderSettings(RenderSettings)

Initialize new instance of the RenderSettings class.

---

Properties

Name

Description

---

Public Property

AmbientLight

Gets or sets the ambient light color used in rendering.

---

Public Property

AntialiasLevel

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

---

Public Property

BackgroundColorBottom

Gets or sets the background bottom color used in rendering.

---

Public Property

BackgroundColorTop

Gets or sets the background top color used in rendering.

Sets also the background color if a solid background color is set.

---

Public Property

BackgroundStyle

How the viewport’s background should be filled.

---

Public Property

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.

---

Public Property

Disposed

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

(Inherited from CommonObject.)

---

Public Property

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.

---

Public Property

FlatShade

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

---

Public Property

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.

---

Public Property

HasUserData

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

(Inherited from CommonObject.)

---

Public Property

ImageDpi

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

---

Public Property

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.

---

Public Property

ImageUnitSystem

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

---

Public Property

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.

(Inherited from CommonObject.)

---

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

---

Public Property

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.

---

Public Property

NamedView

Get or set the given named view

---

Public Property

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.

---

Public Property

RenderAnnotations

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

---

Public Property

RenderBackfaces

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

---

Public Property

RenderChannels

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

---

Public Property

RenderCurves

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

---

Public Property

RenderIsoparams

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

---

Public Property

RenderMeshEdges

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

---

Public Property

RenderPoints

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

---

Public Property

RenderSource

Gets or sets the render source RenderSettings.RenderingSources enumeration.

---

Public Property

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.

---

Public Property

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.

---

Public Property

ShadowmapLevel

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

---

Public Property

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.

---

Public Property

Snapshot

Set or get the given snapshot view

---

Public Property

SpecificViewport

Set or get the given specific viewport

---

Public Property

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.

---

Public Property

TransparentBackground

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

---

Public Property

UseHiddenLights

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

---

Public Property

UserData

List of custom information that is attached to this class.

(Inherited from CommonObject.)

---

Public Property

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.

(Inherited from CommonObject.)

---

Public Property

UseViewportSize

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

---

Methods

Name

Description

---

Protected Method

ConstructConstObject

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

(Inherited from CommonObject.)

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

---

Protected Method

Dispose(Boolean)

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.

(Inherited from CommonObject.)

---

Public Method

Duplicate

Makes a free-floating copy of the object.

---

Public Method

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.

(Inherited from CommonObject.)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Inherited from CommonObject.)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetObjectData

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

(Inherited from CommonObject.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

IsValidWithLog

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

(Inherited from CommonObject.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Protected Method

NonConstOperation

For derived classes implementers.

Defines the necessary implementation to free the instance from being constant.

(Inherited from CommonObject.)

---

Protected Method

OnSwitchToNonConst

Is called when a non-constant operation first occurs.

(Inherited from CommonObject.)

---

Public Method

RenderEnvironment

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 null will be returned.

---

Public Method

RenderEnvironmentId

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.

---

Public Method

RenderEnvironmentOverride

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.

---

Public Method

SetRenderEnvironment

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

---

Public Method

SetRenderEnvironmentId

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.

---

Public Method

SetRenderEnvironmentOverride

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

---

Public Method

ToJSON

Create a JSON string representation of this object

(Inherited from CommonObject.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---