Contains settings used in rendering.
Constructors
public RenderSettings()
Initialize a new instance of the RenderSettings class.
public RenderSettings(RenderSettings source)
Initialize new instance of the RenderSettings class.
Parameters:
| source (RenderSettings) | If not null, settings are copied from source. |
Properties
Gets or sets the ambient light color used in rendering.
Gets or sets anti-alias level, used for render quality
Gets or sets the background bottom color used in rendering.
Gets or sets the background top color used in rendering.
Sets also the background color if a solid background color is set.
How the viewport's background should be filled.
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.
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.
Gets or sets a value indicating whether to render using flat shading.
public GroundPlane GroundPlane { get; }
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.
HasUserData
Gets true if this class has any custom information attached to it through UserData.
Number of dots/inch (dots=pixels) to use when printing and saving bitmaps. The default is 72.0 dots/inch.
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.
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.
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.
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.
Gets or sets a value indicating whether to instruct the rendering engine to show annotations, such as linear dimensions or angular dimensions.
Gets or sets a value indicating whether to render back faces.
If this object is associated with a document, this gets the document render channels. Otherwise it gets a 'free-floating' render channels object.
Gets or sets a value indicating whether to instruct the rendering engine to show curves.
Gets or sets a value indicating whether to instruct the rendering engine to show isocurves.
Gets or sets a value indicating whether to instruct the rendering engine to show mesh edges.
Gets or sets a value indicating whether to instruct the rendering engine to show points.
Gets or sets the render source RenderSettings.RenderingSources enumeration.
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.
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 Skylight Skylight { get; }
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.
Set or get the given specific viewport
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.
Gets or sets whether rendering should be done with transparent background.
UserData
List of custom information that is attached to this class.
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.
Methods
ConstructConstObject
Assigns a parent object and a sub-object index to this.
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
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.
Parameters:
| disposing (bool) | true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer. |
EnsurePrivateCopy
public void 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.
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: true if this object is valid; false otherwise.
NonConstOperation
protected virtual void NonConstOperation()
For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.
OnSwitchToNonConst
protected virtual void OnSwitchToNonConst()
Is called when a non-constant operation first occurs.
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.
Parameters:
| usage (RenderSettings.EnvironmentUsage) | |
| purpose (RenderSettings.EnvironmentPurpose) |
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.
Parameters:
| usage (RenderSettings.EnvironmentUsage) | |
| purpose (RenderSettings.EnvironmentPurpose) |
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.
Parameters:
| usage (RenderSettings.EnvironmentUsage) |
Set the render environment for a particular usage. Passing null for usage Skylighting or Reflection will turn the override for that usage off.
Parameters:
| usage (RenderSettings.EnvironmentUsage) | |
| env (RenderEnvironment) |
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.
Parameters:
| usage (RenderSettings.EnvironmentUsage) | |
| guid (Guid) |
Set the given environment override on/off. Only works for usage Reflection and Skylighting.
Parameters:
| usage (RenderSettings.EnvironmentUsage) | |
| on (bool) |
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |