SoCreateCubeMapSampler

InventorModule

author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoImageSamplers
definition	SoImageSamplers.def
see also	SoVertexShader, SoFragmentShader, SoMLSampler2D
inherits from	SoFramebufferSampler
keywords	cubemap

Purpose

The SoCreateCubeMapSampler module creates a cubemap and renders the given Open Inventor scene into each of the six cubemap faces. The camera is placed at the given World Position, so that the cubemap is valid from the view of that world position. The cube map can either be updated manually or automatically on each rendering.

Usage

The rendered cubemap can be used inside of the shader framework, using its Name as the cubemap sampler.

Windows

Default Panel

Input Fields

child

name: child, type: SoNode

The scene to be rendered into the cubemap.

Output Fields

self

name: self, type: SoNode

The generated samplerCube.

Parameter Fields

Field Index

Auto Update: Bool	Min Filter: Enum	takeSnapshot: Trigger
automaticTraversal: Bool	Mode: Enum	Update: Trigger
Border Color: Vector4	Name: String	Use Separate Render Action: Bool
Clear Alpha: Float	Near Distance: Float	use16BitFloat: Bool
Clear Color: Color	needsTextureCoordinates: Bool	useFormatStateHints: Bool
Color Buffer Format: Enum	Orientation: Rotation	useSizeStateHints: Bool
depthBufferTarget: Enum	pixelScale: Float	World Position: Vector3
Enable Border: Bool	Size: Integer	Wrap S: Enum
Far Distance: Float	sizeMultiplier: Float	Wrap T: Enum
Mag Filter: Enum	stencilBuffer: Bool

Visible Fields

Name

name: name, type: String

Sets the sampler name as it appears in shaders.

see also SoFramebufferSampler.name

Enable Border

name: enableBorder, type: Bool, default: FALSE

see SoFramebufferSampler.enableBorder

Border Color

name: borderColor, type: Vector4, default: 0 0 0 0

see SoFramebufferSampler.borderColor

Min Filter

name: minFilter, type: Enum, default: LINEAR

see SoFramebufferSampler.minFilter

Mag Filter

name: magFilter, type: Enum, default: LINEAR

see SoFramebufferSampler.magFilter

Wrap S

name: wrapS, type: Enum, default: REPEAT

see SoFramebufferSampler.wrapS

Wrap T

name: wrapT, type: Enum, default: REPEAT

see SoFramebufferSampler.wrapT

Clear Color

name: clearColor, type: Color, default: 0 0 0

see SoFramebufferSampler.clearColor

Clear Alpha

name: clearAlpha, type: Float, default: 1, minimum: 0, maximum: 1

see SoFramebufferSampler.clearAlpha

Color Buffer Format

name: colorBufferFormat, type: Enum, default: RGBA

see SoFramebufferSampler.colorBufferFormat

Use Separate Render Action

name: useSeparateRenderAction, type: Bool, default: FALSE

If checked, a separate SoGLRenderAction is used, so that the Open Inventor and GL state above the module does not affect the framebuffer scene rendering.

This means that the camera and any lights above the module will no longer affect the rendering of the scene below the sampler.

see also SoFramebufferSampler.useSeparateRenderAction

Size

name: size, type: Integer, default: 512

Sets the size of the cubemap.

see also SoFramebufferSampler.size

World Position

name: worldPosition, type: Vector3, default: 0 0 0

Sets the world position of the camera that is used to render the cubemap.

Orientation

name: orientation, type: Rotation, default: 0 1 0 3.14159274101257

Sets the main orientation applied to the entire cubemap.

Near Distance

name: nearDistance, type: Float, default: 0.0099999998, minimum: 0

Sets the near clipping distance of the used cameras.

Far Distance

name: farDistance, type: Float, default: 1000, minimum: 0

Sets the far clipping distance of the used cameras.

Auto Update

name: autoUpdate, type: Bool, default: TRUE

If checked, the cubemap is recreated on each re-rendering.

Otherwise, the cubemap is rendered initially and when the Update field is triggered.

Update

name: update, type: Trigger

When pressed, the cubemap rendering is updated.

Mode

name: mode, type: Enum, default: ColorCubeMap

Defines the cubemap mode

Values:

Title	Name	Description
​Color Cube Map	​ColorCubeMap	​Create a color cubemap.
​Depth Cube Map	​DepthCubeMap	​Create a depth cubemap.
​Color And Depth Cube Map	​ColorAndDepthCubeMap	​Create a color and a depth cubemap.

Hidden Fields

use16BitFloat

name: use16BitFloat, type: Bool, default: TRUE

see SoFramebufferSampler.use16BitFloat

needsTextureCoordinates

name: needsTextureCoordinates, type: Bool, default: TRUE

see SoFramebufferSampler.needsTextureCoordinates

depthBufferTarget

name: depthBufferTarget, type: Enum, default: RENDERBUFFER

see SoFramebufferSampler.depthBufferTarget

stencilBuffer

name: stencilBuffer, type: Bool, default: FALSE

see SoFramebufferSampler.stencilBuffer

useSizeStateHints

name: useSizeStateHints, type: Bool, default: FALSE

see SoFramebufferSampler.useSizeStateHints

useFormatStateHints

name: useFormatStateHints, type: Bool, default: FALSE

see SoFramebufferSampler.useFormatStateHints

pixelScale

name: pixelScale, type: Float, default: 1

see SoFramebufferSampler.pixelScale

automaticTraversal

name: automaticTraversal, type: Bool, default: TRUE

see SoFramebufferSampler.automaticTraversal

takeSnapshot

name: takeSnapshot, type: Trigger

see SoFramebufferSampler.takeSnapshot

sizeMultiplier

name: sizeMultiplier, type: Float, default: 1

see SoFramebufferSampler.sizeMultiplier