Skip to content

BH.oM.Adapters.Rhinoceros.ViewCapture.DimensionViewCaptureSettings

View capture settings class with control over the final size of the image in pixels.

Class structure

Implemented interfaces and base types

The DimensionViewCaptureSettings is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Width int Width (in pixels) of the final image. -
Height int Height (in pixels) of the final image. -
FileFormat string File format to be used. Defaults to png. -
ScaleScreenItems bool -
DrawAxes bool Controls if the world axes should be captured or not. -
DrawGrid bool Controls if the grid should be captured or not. -
DrawGridAxes bool Controls if the grid axes should be captured or not. -
TransparentBackground bool Controls if the background should be transparent. -
Preview bool -

Code and Schema

C# implementation

C#
public class DimensionViewCaptureSettings : BH.oM.Adapters.Rhinoceros.ViewCapture.IViewCaptureSettings, BH.oM.Base.IObject

Assembly: Rhinoceros_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Rhinoceros_oM/ViewCapture/DimensionViewCaptureSettings.json"
}

The JSON Schema is available on github here: