Contains settings used in rendering.

Constructors

RenderSettings

#Since v5.0
Initialize a new instance of the RenderSettings class.
public RenderSettings()

RenderSettings

#Since v6.0
Initialize new instance of the RenderSettings class.
public RenderSettings(
RenderSettings
source
If not null, settings are copied from source.
)

Properties

AmbientLight

#Since v5.0
Gets or sets the ambient light color used in rendering.
public Color AmbientLight { get; set; }

AntialiasLevel

#Since v5.0
Gets or sets anti-alias level, used for render quality
public AntialiasLevel AntialiasLevel { get; set; }

BackgroundColorBottom

#Since v5.0
Gets or sets the background bottom color used in rendering.
public Color BackgroundColorBottom { get; set; }

BackgroundColorTop

#Since v5.0
Gets or sets the background top color used in rendering.

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

public Color BackgroundColorTop { get; set; }

BackgroundStyle

#Since v5.0
How the viewport's background should be filled.
public BackgroundStyle BackgroundStyle { get; set; }

DepthCue

#Since v5.0
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 bool DepthCue { get; set; }

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.
public bool Disposed { get; }
inherited fromCommonObject

Dithering

#Since v6.0
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 Dithering Dithering { get; }

FlatShade

#Since v5.0
Gets or sets a value indicating whether to render using flat shading.
public bool FlatShade { get; set; }

GroundPlane

#Since v8.0
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 GroundPlane GroundPlane { get; }

HasUserData

Gets true if this class has any custom information attached to it through UserData.
public bool HasUserData { get; }
inherited fromCommonObject

ImageDpi

#Since v5.11
Number of dots/inch (dots=pixels) to use when printing and saving bitmaps. The default is 72.0 dots/inch.
public double ImageDpi { get; set; }

ImageSize

#Since v5.0
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 Size ImageSize { get; set; }

ImageUnitSystem

#Since v5.11
unit system to use when converting image pixel size and DPI information into a print size. Default = inches
public UnitSystem ImageUnitSystem { get; set; }

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.
public virtual bool IsDocumentControlled { get; }
inherited fromCommonObject

IsValid

Tests an object to see if it is valid.
public virtual bool IsValid { get; }
inherited fromCommonObject

LinearWorkflow

#Since v6.0
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 LinearWorkflow LinearWorkflow { get; }

NamedView

#Since v6.1
Get or set the given named view
public string NamedView { get; set; }

PostEffects

#Since v8.0
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 PostEffectCollection PostEffects { get; }

RenderAnnotations

#Since v5.0
Gets or sets a value indicating whether to instruct the rendering engine to show annotations, such as linear dimensions or angular dimensions.
public bool RenderAnnotations { get; set; }

RenderBackfaces

#Since v5.0
Gets or sets a value indicating whether to render back faces.
public bool RenderBackfaces { get; set; }

RenderChannels

#Since v7.0
If this object is associated with a document, this gets the document render channels. Otherwise it gets a 'free-floating' render channels object.
public RenderChannels RenderChannels { get; }

RenderCurves

#Since v5.0
Gets or sets a value indicating whether to instruct the rendering engine to show curves.
public bool RenderCurves { get; set; }

RenderIsoparams

#Since v5.0
Gets or sets a value indicating whether to instruct the rendering engine to show isocurves.
public bool RenderIsoparams { get; set; }

RenderMeshEdges

#Since v5.0
Gets or sets a value indicating whether to instruct the rendering engine to show mesh edges.
public bool RenderMeshEdges { get; set; }

RenderPoints

#Since v5.0
Gets or sets a value indicating whether to instruct the rendering engine to show points.
public bool RenderPoints { get; set; }

RenderSource

#Since v6.1
Gets or sets the render source RenderSettings.RenderingSources enumeration.
[CLSCompliant(false)] public RenderSettings.RenderingSources RenderSource { get; set; }

SafeFrame

#Since v8.0
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 SafeFrame SafeFrame { get; }

ScaleBackgroundToFit

#Since v6.0
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 bool ScaleBackgroundToFit { get; set; }

ShadowmapLevel

#Since v5.0
0=none, 1=normal, 2=best.
public int ShadowmapLevel { get; set; }

Skylight

#Since v8.0
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 Skylight Skylight { get; }

Snapshot

#Since v6.1
Set or get the given snapshot view
public string Snapshot { get; set; }

SpecificViewport

#Since v6.1
Set or get the given specific viewport
public string SpecificViewport { get; set; }

Sun

#Since v8.0
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 Sun Sun { get; }

TransparentBackground

#Since v6.0
Gets or sets whether rendering should be done with transparent background.
public bool TransparentBackground { get; set; }

UseHiddenLights

#Since v5.0
Gets or sets a value indicating whether to render using lights that are on layers that are off.
public bool UseHiddenLights { get; set; }

UserData

List of custom information that is attached to this class.
public UserDataList UserData { get; }
inherited fromCommonObject

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.
public ArchivableDictionary UserDictionary { get; }
inherited fromCommonObject

UseViewportSize

#Since v5.0
Gets or sets a value indicating whether to use the resolution of the viewport being rendered or ImageSize when rendering
public bool UseViewportSize { get; set; }

Methods

ConstructConstObject

Assigns a parent object and a sub-object index to this.
protected void ConstructConstObject(
parentObject,
The parent object.
subobjectIndex
The sub-object index.
)
inherited fromCommonObject

Dispose

Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
inherited fromCommonObject

Dispose

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.

protected virtual void Dispose(
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
)
inherited fromCommonObject

Duplicate

#Since v8.0
Makes a free-floating copy of the object.
public RenderSettings Duplicate()

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.
public void EnsurePrivateCopy()
inherited fromCommonObject

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] public virtual void GetObjectData(
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
)
inherited fromCommonObject

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
public bool IsValidWithLog(
out string
log
A textual log. This out parameter is assigned during this call.
)
inherited fromCommonObject
true if this object is valid; false otherwise.

NonConstOperation

For derived classes implementers.

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

protected virtual void NonConstOperation()
inherited fromCommonObject

OnSwitchToNonConst

Is called when a non-constant operation first occurs.
protected virtual void OnSwitchToNonConst()
inherited fromCommonObject

RenderEnvironment

#Since v8.0
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 RenderEnvironment RenderEnvironment()

RenderEnvironmentId

#Since v8.0
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 Guid RenderEnvironmentId()

RenderEnvironmentOverride

#Since v8.0
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 bool RenderEnvironmentOverride()

SetRenderEnvironment

#Since v8.0
Set the render environment for a particular usage. Passing null for usage Skylighting or Reflection will turn the override for that usage off.
public void SetRenderEnvironment()

SetRenderEnvironmentId

#Since v8.0
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 void SetRenderEnvironmentId()

SetRenderEnvironmentOverride

#Since v8.0
Set the given environment override on/off. Only works for usage Reflection and Skylighting.
public void SetRenderEnvironmentOverride()

ToJSON

Create a JSON string representation of this object
public string ToJSON()
inherited fromCommonObject