Environment map node. More...

#include <Inventor/nodes/SoEnvironmentMap.h>

Inheritance diagram for SoEnvironmentMap:

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

	SoEnvironmentMap ()

void	setOverride (const SbBool state) override
	Turns the override flag on or off.

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

Public Member Functions inherited from SoNode
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
SoMFFilePathString	filenames
	Names file(s) from which to read the environment map's texture image(s).

SoSFImage	imagePosX
	Contains an in-memory representation of the environment map.

SoSFImage	imagePosY
	See imagePosX.

SoSFImage	imagePosZ
	See imagePosX.

SoSFImage	imageNegX
	See imagePosX.

SoSFImage	imageNegY
	See imagePosX.

SoSFImage	imageNegZ
	See imagePosX.

SoSFFloat	intensity
	Intensity of the environment.

Detailed Description

Environment map node.

This node describes an environment map lighting attribute.

An environment map is defined by a texture that is used to simulate the reflection of the environment on the surface of objects. The node uses a cubemap texture to represent the environment map. The cubemap texture is a 2D texture array with 6 faces, one for each side of a cube.

There are two ways to send the texture to Open Inventor:

Read the texture from the six image files specified in the filenames field.
Specify the textures in memory by setting the the image fields (imagePosX, ...) to contain the texture data.

But in all cases, you must specify the images in this order:

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

The intensity field specifies the intensity of the environment map.

The material properties and light model also affect how the reflections are computed. Enabling specular reflections and setting the shininess of the material to a high value (or the roughness to a low value) produces mirror-like reflections.

FILE FORMAT/DEFAULT

filenames	""
imagePosX	0 0 0
imageNegX	0 0 0
imagePosY	0 0 0
imageNegY	0 0 0
imagePosZ	0 0 0
imageNegZ	0 0 0
intensity	0.2

ACTION BEHAVIOR

SoGLRenderAction

Constructor & Destructor Documentation

◆ SoEnvironmentMap()

SoEnvironmentMap::SoEnvironmentMap ( )

Member Function Documentation

◆ getClassTypeId()

static SoType SoEnvironmentMap::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoEnvironmentMap::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ isOverride()

SbBool SoEnvironmentMap::isOverride ( ) const

inlineoverridevirtual

Returns the state of the override flag.

Reimplemented from SoNode.

Definition at line 171 of file SoEnvironmentMap.h.

◆ setOverride()

void SoEnvironmentMap::setOverride ( const SbBool state )

inlineoverridevirtual

Turns the override flag on or off.

The following property nodes are affected by the override flag: SoBaseColor, SoColorIndex, SoComplexity, SoDepthBuffer, SoDrawStyle, SoEnvironment, SoEnvironmentMap, SoFont, SoFullSceneAntialiasing, SoLightModel, SoMaterial, SoPhysicalMaterial, SoMaterialBinding, SoPackedColor, SoPattern, SoPickStyle, SoPolygonOffset, SoShapeHints, SoVertexProperty, SoTextProperty.

Every node has an override flag associated with it. The override flag is a powerful mechanism typically used (sparingly) near the top of a scene graph. When this flag is set, any nodes of the same type encountered later in the graph are ignored even if they also have their own override flag set. For example, you might insert a line-style SoDrawStyle node at the top of a graph to ensure that the whole scene is drawn as wireframe objects, regardless of drawing styles specified lower in the scene graph. Use the setOverride() method to set and reset the override flag. The isOverride() method returns the state of the override flag.

Normally, the override flag is not used within a scene graph for modeling. Use it in applications where you need to specify a temporary change to the whole graph.

Note: The override flag is not written to a file.

Setting the override flag on a node whose field values are not inherited (for example on a sphere with a radius of 7) has no effect on other nodes in the graph of that type.

Reimplemented from SoNode.

Definition at line 163 of file SoEnvironmentMap.h.

Member Data Documentation

◆ filenames

SoMFFilePathString SoEnvironmentMap::filenames

Names file(s) from which to read the environment map's texture image(s).

The images are used to create a cube map, which is used to simulate the reflection of the environment on the surface of an object.

The standard image file formats are supported. See SoRasterImageRW for the list. If the first file is an HDRI file, only this file is used since it has all 6 faces encoded. If the filename is not an absolute path name, the list of directories maintained by SoInput is searched. If the texture is not found in any of those directories, then the file is searched for relative to the directory from which the SoEnvironmentMap node was read. For example, if an SoEnvironmentMap node with a filenames of "../tofu.rgb" is read from /usr/people/bob/models/food.iv, then /usr/people/bob/tofu.rgb will be read (assuming tofu.rgb isn't found in the directories maintained by SoInput).

Definition at line 119 of file SoEnvironmentMap.h.

◆ imageNegX

SoSFImage SoEnvironmentMap::imageNegX

See imagePosX.

Definition at line 141 of file SoEnvironmentMap.h.

◆ imageNegY

SoSFImage SoEnvironmentMap::imageNegY

See imagePosX.

Definition at line 146 of file SoEnvironmentMap.h.

◆ imageNegZ

SoSFImage SoEnvironmentMap::imageNegZ

See imagePosX.

Definition at line 151 of file SoEnvironmentMap.h.

◆ imagePosX

SoSFImage SoEnvironmentMap::imagePosX

Contains an in-memory representation of the environment map.

The image is set programmatically using the methods provided by SoSFImage.

Definition at line 126 of file SoEnvironmentMap.h.

◆ imagePosY

SoSFImage SoEnvironmentMap::imagePosY

See imagePosX.

Definition at line 131 of file SoEnvironmentMap.h.

◆ imagePosZ

SoSFImage SoEnvironmentMap::imagePosZ

See imagePosX.

Definition at line 136 of file SoEnvironmentMap.h.

◆ intensity

SoSFFloat SoEnvironmentMap::intensity

Intensity of the environment.

Default is 0.2.

Definition at line 156 of file SoEnvironmentMap.h.

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

Inventor/nodes/SoEnvironmentMap.h

Open Inventor Release 2025.1.0

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

Constructor & Destructor Documentation

◆ SoEnvironmentMap()

Member Function Documentation

◆ getClassTypeId()

◆ getTypeId()

◆ isOverride()

◆ setOverride()

Member Data Documentation

◆ filenames

◆ imageNegX

◆ imageNegY

◆ imageNegZ

◆ imagePosX

◆ imagePosY

◆ imagePosZ

◆ intensity