Click or drag to resize

RenderSettings Class

Contains settings used in rendering.
Inheritance Hierarchy
SystemObject
  Rhino.RenderRenderSettings

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class RenderSettings : IDisposable

The RenderSettings type exposes the following members.

Constructors
  NameDescription
Public methodRenderSettings
Initialize a new instance of the RenderSettings class.
Public methodRenderSettings(RenderSettings)
Initialize new instance of the RenderSettings class.
Top
Properties
  NameDescription
Public propertyAmbientLight
Gets or sets the ambient light color used in rendering.
Public propertyAntialiasLevel
Gets or sets antialias level, used for render quality
Public propertyBackgroundColorBottom
Gets or sets the background bottom color used in rendering.
Public propertyBackgroundColorTop
Gets or sets the background top color used in rendering.

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

Public propertyBackgroundStyle
How the viewport's backgroun should be filled.
Public propertyDepthCue
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 propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyDithering
Get the document dithering interface
Public propertyFlatShade
Gets or sets a value indicating whether to render using flat shading.
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyImageDpi
Number of dots/inch (dots=pixels) to use when printing and saving bitmaps. The default is 72.0 dots/inch.
Public propertyImageSize
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 propertyImageUnitSystem
unit system to use when converting image pixel size and dpi information into a print size. Default = inches
Public propertyIsDocumentControlled
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 propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyLinearWorkflow
Get the document linear workflow interface
Public propertyNamedView
Get or set the given named view
Public propertyRenderAnnotations
Gets or sets a value indicating whether to instruct the rendering engine to show annotations, such as linear dimensions or angular dimensions.
Public propertyRenderBackfaces
Gets or sets a value indicating whether to render back faces.
Public propertyRenderCurves
Gets or sets a value indicating whether to instruct the rendering engine to show curves.
Public propertyRenderIsoparams
Gets or sets a value indicating whether to instruct the rendering engine to show isocurves.
Public propertyRenderMeshEdges
Gets or sets a value indicating whether to instruct the rendering engine to show mesh edges.
Public propertyRenderPoints
Gets or sets a value indicating whether to instruct the rendering engine to show points.
Public propertyRenderSource
Public propertyScaleBackgroundToFit
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 propertyShadowmapLevel
0=none, 1=normal, 2=best.
Public propertySnapshot
Set os get the given snapshot view
Public propertySpecificViewport
Set or get the given specific viewport
Public propertyTransparentBackground
Gets or sets whether rendering should be done with transparent background.
Public propertyUseHiddenLights
Gets or sets a value indicating whether to render using lights that are on layers that are off.
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information.
(Inherited from CommonObject.)
Public propertyUseViewportSize
Gets or sets a value indicating whether to use the resolution of the viewport being rendered or ImageSize when rendering
Top
Methods
  NameDescription
Protected methodConstructConstObject
Assigns a parent object and a subobject index to this.
(Inherited from CommonObject.)
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.


In Rhino for Windows 6.18, this member is inherited from CommonObjectDispose.
Protected methodDispose(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.



In Rhino for Windows 6.18, this member is inherited from CommonObjectDispose(Boolean).
Public methodEnsurePrivateCopy
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 methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Overrides ObjectFinalize.)

In Rhino for Windows, this member is overridden by Finalize.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNonConstOperation
For derived classes implementers.

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

(Inherited from CommonObject.)
Protected methodOnSwitchToNonConst
Is called when a non-const operation first occurs.
(Inherited from CommonObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.18
See Also