Class RenderSettings

Hierarchy (view full)

Constructors

Properties

ambientLight: object

Gets or sets the ambient light color used in rendering in js object format: {r:number, g:number, b:number)} where number is from 0 - 255

backgroundColorBottom: object

Gets or sets the background bottom color used in rendering in js object format: {r:number, g:number, b:number)} where number is from 0 - 255

backgroundColorTop: object

Gets or sets the background top color used in rendering in js object format: {r:number, g:number, b:number)} where number is from 0 - 255 Sets also the background color if a solid background color is set.

depthCue: boolean

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.

dithering: Dithering

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.

flatShade: boolean

Gets or sets a value indicating whether to render using flat shading.

groundPlane: GroundPlane

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.

imageDpi: number

Number of dots/inch (dots=pixels) to use when printing and saving bitmaps. The default is 72.0 dots/inch.

isValid: boolean

Tests an object to see if it is valid.

isValidWithLog: [boolean, string]

...

linearWorkflow: LinearWorkflow

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.

namedView: string

Get or set the given named view

postEffects: PostEffect[]

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.

renderAnnotations: boolean

Gets or sets a value indicating whether to instruct the rendering engine to show annotations, such as linear dimensions or angular dimensions.

renderBackFaces: boolean

Gets or sets a value indicating whether to render back faces.

renderChannels: RenderChannels

If this object is associated with a document, this gets the document render channels. Otherwise it gets a 'free-floating' render channels object.

renderCurves: boolean

Gets or sets a value indicating whether to instruct the rendering engine to show curves.

renderEnvironments: RenderEnvironments
renderIsoParams: boolean

Gets or sets a value indicating whether to instruct the rendering engine to show isocurves.

renderMeshEdges: boolean

Gets or sets a value indicating whether to instruct the rendering engine to show mesh edges.

renderPoints: boolean

Gets or sets a value indicating whether to instruct the rendering engine to show points.

safeFrame: SafeFrame

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.

scaleBackgroundToFit: boolean

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: number

0=none, 1=normal, 2=best.

skylight: Skylight

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.

snapShot: string

Set or get the given snapshot view

specificViewport: string

Set or get the given specific viewport

sun: Sun

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.

transparentBackground: boolean

Gets or sets whether rendering should be done with transparent background.

useHiddenLights: boolean

Gets or sets a value indicating whether to render using lights that are on layers that are off.

useViewportSize: boolean

Gets or sets a value indicating whether to use the resolution of the viewport being rendered or ImageSize when rendering

userStringCount: number

Gets the amount of user strings.

Methods

  • Parameters

    • key: string

      id used to retrieve the string.

    Returns string

    string associated with the key if successful. null if no key was found.

    Description

    Gets user string from this geometry.

  • Parameters

    • key: string

      id used to retrieve this string.

    • value: string

      string associated with key.

    Returns boolean

    true if successful, false if not.

    Description

    Attach a user string (key,value combination) to this geometry.

  • Parameters

    • json: object

      A json formatted object in the following format (values are orientative):

      {
      version: 10000,
      archive3dm: 60,
      opennurbs: -1877964208,
      data: 'encoded 3dm object data'
      }

    Returns CommonObject

    Description

    Decodes a Rhino Object

Generated using TypeDoc