com.openinventor.inventor.nodes

Class SoRenderToTextureProperty

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoRenderToTextureProperty

All Implemented Interfaces:

SafeDisposable

public class SoRenderToTextureProperty
extends SoNode

Class for creating a texture by rendering a scene graph. This class is used to define an image for texture mapping which is created by rendering a scene graph.

It can be used with the classes SoTexture2 and SoTextureCubeMap. Create the SoRenderToTextureProperty node and assign it to the renderToTextureProperty field of the texture mapping node.

The SoRenderToTarget node can also be used to create texture images.

One of the two fields, node or path, must be defined.

The scene graph should normally contain a camera and at least one light. Unlike SoRenderToTarget, the children of SoRenderToTextureProperty do not inherit the camera, lights, etc from the main scene graph.

Note that the default image size is 0,0 (effectively disables rendering).

File format/default:

RenderToTextureProperty {

node	[]
path	""
updatePolicy	WHEN_NEEDED
backgroundColor	0 0 0
size	0 0
component	RGB

}

See also:

SoTexture2, SoTextureCubeMap

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoRenderToTextureProperty.Components Rendering component enumeration values.
static class	SoRenderToTextureProperty.UpdatePolicies Update Policy enumeration values.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFColor	backgroundColor Background color used when rendering the scene graph.
SoSFEnum<SoRenderToTextureProperty.Components>	component Specifies the type of component(s) for the rendering.
static int	DEPTH Deprecated. Use SoRenderToTextureProperty.Components.DEPTH instead.
static int	EACH_FRAME Deprecated. Use SoRenderToTextureProperty.UpdatePolicies.EACH_FRAME instead.
SoMFNode	node Specifies the scene graph(s) (SoNode(s)) to be rendered into the texture.
static int	ON_TRIGGER Deprecated. Use SoRenderToTextureProperty.UpdatePolicies.ON_TRIGGER instead.
SoMFPath	path Specifies the scene graph(s) (SoPath(s)) to be rendered into the texture.
static int	RGB Deprecated. Use SoRenderToTextureProperty.Components.RGB instead.
static int	RGB_ALPHA Deprecated. Use SoRenderToTextureProperty.Components.RGB_ALPHA instead.
static int	RGB_TRANSPARENCY Deprecated. Use SoRenderToTextureProperty.Components.RGB_TRANSPARENCY instead.
SoSFVec2s	size Size in pixels of the rendered texture.
SoSFTrigger	trigger Trigger field to render the scene into the Pbuffer.
SoSFEnum<SoRenderToTextureProperty.UpdatePolicies>	updatePolicy Specifies the policy for rendering to the texture.
static int	WHEN_NEEDED Deprecated. Use SoRenderToTextureProperty.UpdatePolicies.WHEN_NEEDED instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoRenderToTextureProperty()

Method Summary

Modifier and Type	Method and Description
SoGLRenderAction	getGLRenderAction() Returns the render action used for rendering the scene.
void	setContextForSharing(SoGLContext context) Set OpenGL render context for display list sharing.
void	setGLRenderAction(SoGLRenderAction ra) Specifies a custom render action to use for rendering the scene.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EACH_FRAME

@Deprecated
public static final int EACH_FRAME

Deprecated. Use SoRenderToTextureProperty.UpdatePolicies.EACH_FRAME instead.

WHEN_NEEDED

@Deprecated
public static final int WHEN_NEEDED

Deprecated. Use SoRenderToTextureProperty.UpdatePolicies.WHEN_NEEDED instead.

ON_TRIGGER

@Deprecated
public static final int ON_TRIGGER

Deprecated. Use SoRenderToTextureProperty.UpdatePolicies.ON_TRIGGER instead.

RGB

@Deprecated
public static final int RGB

Deprecated. Use SoRenderToTextureProperty.Components.RGB instead.

RGB_TRANSPARENCY

@Deprecated
public static final int RGB_TRANSPARENCY

Deprecated. Use SoRenderToTextureProperty.Components.RGB_TRANSPARENCY instead.

RGB_ALPHA

@Deprecated
public static final int RGB_ALPHA

Deprecated. Use SoRenderToTextureProperty.Components.RGB_ALPHA instead.

DEPTH

@Deprecated
public static final int DEPTH

Deprecated. Use SoRenderToTextureProperty.Components.DEPTH instead.

node

public final SoMFNode node

Specifies the scene graph(s) (SoNode(s)) to be rendered into the texture. For use with SoTexture2, only one scene graph should be specified. For use with SoTextureCube map, six scene graphs must be specified, one for each face of the cube in the order:

• imagePosX (left)
• imagePosY (bottom)
• imagePosZ (back)
• imageNegX (right)
• imageNegY (top)
• imageNegZ (front)

The node field has priority over the path field. Null by default.

path

public final SoMFPath path

Specifies the scene graph(s) (SoPath(s)) to be rendered into the texture. For use with SoTexture2, only one path should be specified. For use with SoTextureCube map, six paths must be specified, one for each face of the cube in the order:

• imagePosX (left)
• imagePosY (right)
• imagePosZ (top)
• imageNegX (bottom)
• imageNegY (back)
• imageNegZ (front)

The node field has priority over the path field. Null by default.

updatePolicy

public final SoSFEnum<SoRenderToTextureProperty.UpdatePolicies> updatePolicy

Specifies the policy for rendering to the texture. Use enum UpdatePolicy. Default is WHEN_NEEDED.

backgroundColor

public final SoSFColor backgroundColor

Background color used when rendering the scene graph. Black by default.

size

public final SoSFVec2s size

Size in pixels of the rendered texture. If the size is not a power of two (e.g. 128 or 256) and the OpenGL extension texture_non_power_of_two is not supported by the GPU, the size will be automatically scaled to the next power of two (less effective). (0, 0) by default.

component

public final SoSFEnum<SoRenderToTextureProperty.Components> component

Specifies the type of component(s) for the rendering. Use enum Component. Default is RGB.

trigger

public final SoSFTrigger trigger

Trigger field to render the scene into the Pbuffer. Effective only if updatePolicy is ON_TRIGGER.

Constructor Detail

SoRenderToTextureProperty

public SoRenderToTextureProperty()

Method Detail

setContextForSharing

public void setContextForSharing(SoGLContext context)

Set OpenGL render context for display list sharing. Must be set before calling the create() method. There is no guarantee that sharing will be allowed.

setGLRenderAction

public void setGLRenderAction(SoGLRenderAction ra)

Specifies a custom render action to use for rendering the scene.

getGLRenderAction

public SoGLRenderAction getGLRenderAction()

Returns the render action used for rendering the scene.