RhinoCommon API
RenderSettings Class |
Contains settings used in rendering.
Inheritance HierarchyNamespace: Rhino.Render
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe RenderSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RenderSettings | Initialize a new instance of the RenderSettings class. |
| RenderSettings(RenderSettings) | Initialize new instance of the RenderSettings class. |
Properties| Name | Description | |
|---|---|---|
 | 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.
(Inherited from CommonObject.) |
| Dithering |
Get the document dithering interface
|
| FlatShade |
Gets or sets a value indicating whether to render using flat shading.
|
| HasUserData |
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.) |
| 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.
(Inherited from CommonObject.) |
| IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) |
| LinearWorkflow |
Get the document linear workflow interface
|
| NamedView |
Get or set the given named view
|
| 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 |
Get the document render channels interface
|
| 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 RenderSettingsRenderingSources enumeration.
|
| 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.
|
| Snapshot |
Set or get the given snapshot view
|
| SpecificViewport |
Set or get the given specific viewport
|
| 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.
(Inherited from CommonObject.) |
| UserDictionary |
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.) |
| UseViewportSize |
Gets or sets a value indicating whether to use the resolution of the
viewport being rendered or ImageSize when rendering
|
Methods| Name | Description | |
|---|---|---|
 | ConstructConstObject |
Assigns a parent object and a sub-object index to this.
(Inherited from CommonObject.) |
| Dispose |
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.) |
| Dispose(Boolean) |
For derived class implementers.
(Inherited from CommonObject.)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. |
| 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.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsValidWithLog |
Determines if an object is valid. Also provides a report on errors if this
object happens not to be valid.
(Inherited from CommonObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NonConstOperation |
For derived classes implementers.
(Inherited from CommonObject.)Defines the necessary implementation to free the instance from being constant. |
| OnSwitchToNonConst |
Is called when a non-constant operation first occurs.
(Inherited from CommonObject.) |
| ToJSON |
Create a JSON string representation of this object
(Inherited from CommonObject.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also