C# Class RhinoCyclesCore.CyclesBackground

Helper class to hold background/world shader related data and state
Inheritance: IDisposable
Show file Open project: mcneel/RhinoCycles Class Usage Examples

Public Properties

Property Type Description
PlanarProjection bool
Xml string
background_environment Rhino.Render.RenderEnvironment
background_fill BackgroundStyle
bg CyclesTextureImage
bg_color Color
color1 Color
color2 Color
m_float_as_byte bool
modified bool
refl CyclesTextureImage
refl_color Color
reflection_environment Rhino.Render.RenderEnvironment
sky CyclesTextureImage
sky_color Color
skylight_enabled bool
skylight_environment Rhino.Render.RenderEnvironment
wallpaper CyclesTextureImage
wallpaper_solid Color

Public Methods

Method Description
Dispose ( ) : void
HandleEnvironments ( ) : void

Read texture data and bg color from environments
HandleWallpaper ( Rhino.DocObjects.ViewInfo view ) : void

Same as HandleWallpaper(ViewInfo, bool), but re-use old scaletofit setting
HandleWallpaper ( Rhino.DocObjects.ViewInfo view, bool scaleToFit ) : void
Reset ( ) : void

Reset modified flag.

Method Details

Dispose() public method

public Dispose ( ) : void
return void

HandleEnvironments() public method

Read texture data and bg color from environments
public HandleEnvironments ( ) : void
return void

HandleWallpaper() public method

Same as HandleWallpaper(ViewInfo, bool), but re-use old scaletofit setting
public HandleWallpaper ( Rhino.DocObjects.ViewInfo view ) : void
view Rhino.DocObjects.ViewInfo
return void

HandleWallpaper() public method

public HandleWallpaper ( Rhino.DocObjects.ViewInfo view, bool scaleToFit ) : void
view Rhino.DocObjects.ViewInfo
scaleToFit bool
return void

Reset() public method

Reset modified flag.
public Reset ( ) : void
return void

Property Details

PlanarProjection public property

public bool PlanarProjection
return bool

Xml public property

public string Xml
return string

background_environment public property

Environment used for background (360deg environment)
public RenderEnvironment,Rhino.Render background_environment
return Rhino.Render.RenderEnvironment

background_fill public property

Get background style.
public BackgroundStyle background_fill
return BackgroundStyle

bg public property

Hold texture data for background (360deg)
public CyclesTextureImage,RhinoCyclesCore bg
return CyclesTextureImage

bg_color public property

Background color, used if bg is no image
public Color bg_color
return Color

color1 public property

Solid color or top color for gradient
public Color color1
return Color

color2 public property

Bottom color for gradient
public Color color2
return Color

m_float_as_byte public property

OpenCL doesn't properly support HDRi textures in the environment, so read them as byte textures instead.
public bool m_float_as_byte
return bool

modified public property

True if ChangeQueue modified the background
public bool modified
return bool

refl public property

Hold texture data for reflection
public CyclesTextureImage,RhinoCyclesCore refl
return CyclesTextureImage

refl_color public property

Reflection color, used if refl has no image
public Color refl_color
return Color

reflection_environment public property

Custom environment to use for reflections. If not set, use background_environment, solid color or gradient, whichever is used as background
public RenderEnvironment,Rhino.Render reflection_environment
return Rhino.Render.RenderEnvironment

sky public property

Hold texture data for skylight
public CyclesTextureImage,RhinoCyclesCore sky
return CyclesTextureImage

sky_color public property

Sky color, used if sky has no image
public Color sky_color
return Color

skylight_enabled public property

True if skylight is enabled
public bool skylight_enabled
return bool

skylight_environment public property

Custom environment used for skylight. If not set, background_environment will be used.
public RenderEnvironment,Rhino.Render skylight_environment
return Rhino.Render.RenderEnvironment

wallpaper public property

Hold texture data for wallpaper
public CyclesTextureImage,RhinoCyclesCore wallpaper
return CyclesTextureImage

wallpaper_solid public property

Solid bg color to show outside of wallpaper when not set to Stretch to Fit
public Color wallpaper_solid
return Color