Class for creating a texture by rendering a scene graph More...

#include <Inventor/nodes/SoRenderToTextureProperty.h>

Inheritance diagram for SoRenderToTextureProperty:

Public Types
enum	UpdatePolicy { EACH_FRAME , WHEN_NEEDED , ON_TRIGGER }
	Update Policy enumeration values. More...

enum	Component { RGB , RGB_TRANSPARENCY , RGB_ALPHA = RGB_TRANSPARENCY , DEPTH }
	Rendering component enumeration values. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoRenderToTextureProperty ()

void	setGLRenderAction (SoGLRenderAction *ra)
	Specifies a custom render action to use for rendering the scene.

SoGLRenderAction *	getGLRenderAction () const
	Returns the render action used for rendering the scene.

Deprecated

SoDEPRECATED void	setGraphicConfigTemplate (SoGLGraphicConfigTemplate *)

SoDEPRECATED SoGLGraphicConfigTemplate *	getGraphicConfigTemplate ()

SoDEPRECATED void	setContextForSharing (SoGLContext *)

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoMFNode	node
	Specifies the scene graph(s) (SoNode(s)) to be rendered into the texture.

SoMFPath	path
	Specifies the scene graph(s) (SoPath(s)) to be rendered into the texture.

SoSFEnum	updatePolicy
	Specifies the policy for rendering to the texture.

SoSFColor	backgroundColor
	Background color used when rendering the scene graph.

SoSFVec2s	size
	Size in pixels of the rendered texture.

SoSFEnum	component
	Specifies the type of component(s) for the rendering.

SoSFTrigger	trigger
	Trigger field to render the scene into the Pbuffer.

Detailed Description

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

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

Member Enumeration Documentation

◆ Component

enum SoRenderToTextureProperty::Component

Rendering component enumeration values.

Enumerator
RGB	Default. The RGB components are rendered to the texture.
RGB_TRANSPARENCY	The RGB and alpha components are rendered to the texture.
RGB_ALPHA
DEPTH	The depth component is rendered to the texture.

Definition at line 131 of file SoRenderToTextureProperty.h.

◆ UpdatePolicy

enum SoRenderToTextureProperty::UpdatePolicy

Update Policy enumeration values.

Enumerator

EACH_FRAME

The texture is updated at each traversal of the shape it is mapped to.

WHEN_NEEDED

Default.

The texture is updated only if the path or node fields have changed.

ON_TRIGGER

The texture is updated only if the trigger field is touched.

Definition at line 114 of file SoRenderToTextureProperty.h.

Constructor & Destructor Documentation

◆ SoRenderToTextureProperty()

SoRenderToTextureProperty::SoRenderToTextureProperty ( )

Member Function Documentation

◆ getClassTypeId()

static SoType SoRenderToTextureProperty::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getGLRenderAction()

SoGLRenderAction * SoRenderToTextureProperty::getGLRenderAction ( ) const

Returns the render action used for rendering the scene.

◆ getGraphicConfigTemplate()

SoDEPRECATED SoGLGraphicConfigTemplate * SoRenderToTextureProperty::getGraphicConfigTemplate ( )

inline

Definition at line 229 of file SoRenderToTextureProperty.h.

◆ getTypeId()

virtual SoType SoRenderToTextureProperty::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ setContextForSharing()

SoDEPRECATED void SoRenderToTextureProperty::setContextForSharing ( SoGLContext * )

inline

Definition at line 232 of file SoRenderToTextureProperty.h.

◆ setGLRenderAction()

void SoRenderToTextureProperty::setGLRenderAction ( SoGLRenderAction * ra )

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

◆ setGraphicConfigTemplate()

SoDEPRECATED void SoRenderToTextureProperty::setGraphicConfigTemplate ( SoGLGraphicConfigTemplate * )

inline

Definition at line 226 of file SoRenderToTextureProperty.h.

Member Data Documentation

◆ backgroundColor

SoSFColor SoRenderToTextureProperty::backgroundColor

Background color used when rendering the scene graph.

Black by default.

Definition at line 193 of file SoRenderToTextureProperty.h.

◆ component

SoSFEnum SoRenderToTextureProperty::component

Specifies the type of component(s) for the rendering.

Use enum Component. Default is RGB.

Definition at line 205 of file SoRenderToTextureProperty.h.

◆ node

SoMFNode SoRenderToTextureProperty::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)
imageNegX (right)
imagePosY (bottom)
imageNegY (top)
imagePosZ (back)
imageNegZ (front)

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

Definition at line 165 of file SoRenderToTextureProperty.h.

◆ path

SoMFPath SoRenderToTextureProperty::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)
imageNegX (right)
imagePosY (bottom)
imageNegY (top)
imagePosZ (back)
imageNegZ (front)

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

Definition at line 182 of file SoRenderToTextureProperty.h.

◆ size

SoSFVec2s SoRenderToTextureProperty::size

Size in pixels of the rendered texture.

(0, 0) by default.

Definition at line 199 of file SoRenderToTextureProperty.h.

◆ trigger

SoSFTrigger SoRenderToTextureProperty::trigger

Trigger field to render the scene into the Pbuffer.

Effective only if updatePolicy is ON_TRIGGER.

Definition at line 211 of file SoRenderToTextureProperty.h.

◆ updatePolicy

SoSFEnum SoRenderToTextureProperty::updatePolicy

Specifies the policy for rendering to the texture.

Use enum UpdatePolicy. Default is WHEN_NEEDED.

Definition at line 188 of file SoRenderToTextureProperty.h.

The documentation for this class was generated from the following file:

Inventor/nodes/SoRenderToTextureProperty.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

SEE ALSO

Member Enumeration Documentation

◆ Component

◆ UpdatePolicy

Constructor & Destructor Documentation

◆ SoRenderToTextureProperty()

Member Function Documentation

◆ getClassTypeId()

◆ getGLRenderAction()

◆ getGraphicConfigTemplate()

◆ getTypeId()

◆ setContextForSharing()

◆ setGLRenderAction()

◆ setGraphicConfigTemplate()

Member Data Documentation

◆ backgroundColor

◆ component

◆ node

◆ path

◆ size

◆ trigger

◆ updatePolicy