RenderSettings

class rhino3dm.RenderSettings

RenderSettings()

RenderSettings constructor

RenderSettings()

RenderSettings constructor

AmbientLight

System.Drawing.Color: Gets or sets the ambient light color used in rendering.

BackgroundColorTop

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

BackgroundColorBottom

System.Drawing.Color: Gets or sets the background bottom color used in rendering.

UseHiddenLights

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

DepthCue

bool: 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.

FlatShade

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

RenderBackFaces

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

RenderPoints

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

RenderCurves

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

RenderIsoParams

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

RenderMeshEdges

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

RenderAnnotations

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

UseViewportSize

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

ScaleBackgroundToFit

bool: 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.

TransparentBackground

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

ImageDpi

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

ShadowMapLevel

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

NamedView

str: Get or set the given named view

SnapShot

str: Set or get the given snapshot view

SpecificViewport

str: Set or get the given specific viewport

GroundPlane

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.

SafeFrame

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.

Dithering

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.

Skylight

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.

LinearWorkflow

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.

RenderChannels

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

Sun

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.

RenderEnvironments

PostEffects

PostEffectCollection: 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.