RenderOptions (Bonzai Engine bonzaiengine.com Copyright © 2007-2015 Jérôme Jouvie)

java.lang.Object
- com.bonzaiengine.renderer.RenderOptions

All Implemented Interfaces:: java.lang.Cloneable

public class RenderOptions
extends java.lang.Object
implements java.lang.Cloneable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`Bone` Skeleton bones
`static int`	`BVSolid` Solid Bounding Volume
`static int`	`BVTransparent` Transparent Bounding Volume
`static int`	`BVWired` Wired Bounding Volume
`static int`	`Joints` Skeleton joint
`static int`	`JointsBv` Skeleton joint bounding volume
`static int`	`JointsOrient` Skeleton joint orientation
`static int`	`Outlining` with outlining For outlined, use (RenderOptions.Solid \| RenderOptions.Outlining) or RenderMode.SolidOutlined)
`static int`	`Point` Point
`static int`	`Solid` Solid
`static int`	`SurfaceTransparent` Surface transparent
`static int`	`TBN` Tangent/Binormal/Normal vectors
`static int`	`Transparent` Transparent
`static int`	`Wired` Wired

Constructor Summary

Constructors
Constructor and Description

RenderOptions()

Constructors
Constructor and Description
`RenderOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBoundingVolumeOptions()`
`LightModel`	`getLightModel()`
`<L extends ILight> Lights<L>`	`getLights()`
`Picker`	`getPickingPicker()`
`int`	`getRenderMode()`
`java.lang.String`	`getSurface()`
`float`	`getTransparentAlpha()`
`boolean`	`isDrawBoundingVolume()`
`boolean`	`isDrawWorldAxis()`
`boolean`	`isPicking()`
`boolean`	`isPickingRootModelOnly()`
`boolean`	`isUseShader()` Default value: `true`
`void`	`setBoundingVolumeOptions(int bvOptions)`
`void`	`setDrawBoundingVolume(boolean drawBoundingVolume)`
`void`	`setDrawWorldAxis(boolean drawWorldAxis)`
`void`	`setLightModel(LightModel lightModel)`
`void`	`setLights(Lights<?> lights)` `Lights` is required when `Shader` uses lighting informations.
`void`	`setPicking(boolean picking)` Default value: `false`
`void`	`setPickingPicker(Picker picker)` Specify the picking `Picker` Default value: `null`
`void`	`setPickingRootModelOnly(boolean pickRootOnly)` Picking level Default value: `true`
`void`	`setRenderMode(int renderMode)`
`void`	`setSurface(java.lang.String surface)` Default value: `SurfaceTypes.SURFACE_DEFAULT`
`void`	`setTransparentAlpha(float transparencyAlpha)` Default value: `0.2f`
`void`	`setUseShader(boolean useShader)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - Solid
```
public static final int Solid
```
    Solid
    
    See Also:
    
    Constant Field Values
  - Wired
```
public static final int Wired
```
    Wired
    
    See Also:
    
    Constant Field Values
  - Point
```
public static final int Point
```
    Point
    
    See Also:
    
    Constant Field Values
  - Transparent
```
public static final int Transparent
```
    Transparent
    
    See Also:
    
    Constant Field Values
  - Outlining
```
public static final int Outlining
```
    with outlining
    For outlined, use (RenderOptions.Solid | RenderOptions.Outlining) or RenderMode.SolidOutlined)
    
    See Also:
    
    Constant Field Values
  - BVSolid
```
public static final int BVSolid
```
    Solid Bounding Volume
    
    See Also:
    
    Constant Field Values
  - BVWired
```
public static final int BVWired
```
    Wired Bounding Volume
    
    See Also:
    
    Constant Field Values
  - BVTransparent
```
public static final int BVTransparent
```
    Transparent Bounding Volume
    
    See Also:
    
    Constant Field Values
  - TBN
```
public static final int TBN
```
    Tangent/Binormal/Normal vectors
    
    See Also:
    
    Constant Field Values
  - Bone
```
public static final int Bone
```
    Skeleton bones
    
    See Also:
    
    Constant Field Values
  - Joints
```
public static final int Joints
```
    Skeleton joint
    
    See Also:
    
    Constant Field Values
  - JointsOrient
```
public static final int JointsOrient
```
    Skeleton joint orientation
    
    See Also:
    
    Constant Field Values
  - JointsBv
```
public static final int JointsBv
```
    Skeleton joint bounding volume
    
    See Also:
    
    Constant Field Values
  - SurfaceTransparent
```
public static final int SurfaceTransparent
```
    Surface transparent
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RenderOptions
```
public RenderOptions()
```
- Method Detail
  - isUseShader
```
public boolean isUseShader()
```
    Default value: true
    
    Returns:
    
    true if renderer could use shaders (disabled if extension not available)
  - setUseShader
```
public void setUseShader(boolean useShader)
```
  - setSurface
```
public final void setSurface(java.lang.String surface)
```
    Default value: SurfaceTypes.SURFACE_DEFAULT
    
    Parameters:
    
    surface - the surface name, used for rendering material
  - getSurface
```
public final java.lang.String getSurface()
```
  - getRenderMode
```
public final int getRenderMode()
```
    Returns:
    
    the return
  - setRenderMode
```
public final void setRenderMode(int renderMode)
```
    See Also:
    
    RenderMode
  - getTransparentAlpha
```
public float getTransparentAlpha()
```
  - setTransparentAlpha
```
public void setTransparentAlpha(float transparencyAlpha)
```
    Default value: 0.2f
    
    Parameters:
    
    transparencyAlpha - alpha value used with transparent RenderMode
  - getBoundingVolumeOptions
```
public final int getBoundingVolumeOptions()
```
  - setBoundingVolumeOptions
```
public final void setBoundingVolumeOptions(int bvOptions)
```
  - isDrawWorldAxis
```
public final boolean isDrawWorldAxis()
```
  - setDrawWorldAxis
```
public final void setDrawWorldAxis(boolean drawWorldAxis)
```
  - isDrawBoundingVolume
```
public final boolean isDrawBoundingVolume()
```
  - setDrawBoundingVolume
```
public final void setDrawBoundingVolume(boolean drawBoundingVolume)
```
  - isPicking
```
public boolean isPicking()
```
  - setPicking
```
public void setPicking(boolean picking)
```
    Default value: false
    
    Parameters:
    
    picking - true to enable picking renderer
    
    See Also:
    
    setPickingPicker(Picker)
  - getPickingPicker
```
public Picker getPickingPicker()
```
  - setPickingPicker
```
public void setPickingPicker(Picker picker)
```
    Specify the picking Picker
    Default value: null
    
    Parameters:
    
    picker - specify the Picker, only used when pickign is enabled
    
    See Also:
    
    setPicking(boolean)
  - isPickingRootModelOnly
```
public boolean isPickingRootModelOnly()
```
  - setPickingRootModelOnly
```
public void setPickingRootModelOnly(boolean pickRootOnly)
```
    Picking level
    Default value: true
    
    Parameters:
    
    pickRootOnly - true to only pick the root model
  - getLights
```
public final <L extends ILight> Lights<L> getLights()
```
  - setLights
```
public final void setLights(Lights<?> lights)
```
    Lights is required when Shader uses lighting informations.
    Default value: null
    
    Parameters:
    
    lights - specified the Lights used during rendering
  - getLightModel
```
public LightModel getLightModel()
```
  - setLightModel
```
public void setLightModel(LightModel lightModel)
```

Class RenderOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Solid

Wired

Point

Transparent

Outlining

BVSolid

BVWired

BVTransparent

TBN

Bone

Joints

JointsOrient

JointsBv

SurfaceTransparent

Constructor Detail

RenderOptions

Method Detail

isUseShader

setUseShader

setSurface

getSurface

getRenderMode

setRenderMode

getTransparentAlpha

setTransparentAlpha

getBoundingVolumeOptions

setBoundingVolumeOptions

isDrawWorldAxis

setDrawWorldAxis

isDrawBoundingVolume

setDrawBoundingVolume

isPicking

setPicking

getPickingPicker

setPickingPicker

isPickingRootModelOnly

setPickingRootModelOnly

getLights

setLights

getLightModel

setLightModel