Image background node. More...

#include <Inventor/nodes/SoImageBackground.h>

Inheritance diagram for SoImageBackground:

Public Types
enum	Style { NONE , CENTER , LOWER_LEFT , UPPER_LEFT , UPPER_RIGHT , LOWER_RIGHT , STRETCH , TILE , CROP , FIT }
	Image background style. More...

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

	SoImageBackground ()
	Creates a background image node with default settings.

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 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 SoBackground
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
SoSFFilePathString	filename
	Names file from which to read texture image.

SoSFImage	image
	Contains an in-memory representation of the texture map.

SoSFEnum	style
	Specifies how the image will be mapped onto the window.

Detailed Description

Image background node.

Draws a background image.

This node provides a convenient way of rendering an image in the background of the scene. The position options like LOWER_LEFT can be used, for example, to place a logo in the corner of the window. The STRETCH and TILE options cause the image to fill the window and automatically adjust if the window size changes.

Note that the SoImage node can also be used to place an image in the scene, but the position of the image is specified in 3D coordinates. This node positions images relative to the physical drawing window.

Generally background nodes should be placed at the beginning of the scene graph so that geometry is drawn on top of the background. Background nodes have no size, are not pickable, and do not modify the OpenGL depth buffer.

Another convenient feature is that this node renders correctly on a tiled display that represents a single large virtual window, for example using the MultiPipe extension (see SoXtMPExaminerViewer). The image will be stretched or tiled across the entire virtual window.

FILE FORMAT/DEFAULT

filename	""
image	0 0 0 0
style	TILE

ACTION BEHAVIOR

SoGLRenderAction

Member Enumeration Documentation

◆ Style

enum SoImageBackground::Style

Image background style.

Enumerator
NONE	No image is rendered.
CENTER	Image is rendered actual size, centered in the window (image aspect ratio is preserved but image may be cropped and background may be visible).
LOWER_LEFT	Image is rendered actual size in lower left corner (image aspect ratio is preserved but image may be cropped and background may be visible).
UPPER_LEFT	Image is rendered actual size in upper left corner (image aspect ratio is preserved but image may be cropped and background may be visible).
UPPER_RIGHT	Image is rendered actual size in upper right corner (image aspect ratio is preserved but image may be cropped and background may be visible).
LOWER_RIGHT	Image is rendered actual size in lower right corner (image aspect ratio is preserved but image may be cropped and background may be visible).
STRETCH	Image is stretched to exactly fill the viewport in both directions (image aspect ratio is not preserved).
TILE	Image is tiled to fill window starting from lower left corner (image aspect ratio is preserved).
CROP	Image is centered and stretched to exactly fill the longer dimension of the viewport (width or height) (image aspect ratio is preserved but portions of image will be cropped if the aspect ratio of the image and viewport are different).
FIT	Image is centered and stretched to exactly fill the shorter dimension of the viewport (width or height) (image aspect ratio is preserved but background color will be visible on sides or top and bottom of the image if the aspect ratio of the image and viewport are different).

Definition at line 102 of file SoImageBackground.h.

Constructor & Destructor Documentation

◆ SoImageBackground()

SoImageBackground::SoImageBackground ( )

Creates a background image node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoImageBackground::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoImageBackground::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoBackground.

Member Data Documentation

◆ filename

SoSFFilePathString SoImageBackground::filename

Names file from which to read texture image.

The standard image file formats are supported. See SoRasterImageRW for the list. 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 node was read. For example, if a node with a filename 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 169 of file SoImageBackground.h.

◆ image

SoSFImage SoImageBackground::image

Contains an in-memory representation of the texture map.

It is either the contents of the file read from filename, an image read directly from an Open Inventor file, or an image set programmatically using the methods provided by SoSFImage.

Definition at line 177 of file SoImageBackground.h.

◆ style

SoSFEnum SoImageBackground::style

Specifies how the image will be mapped onto the window.

Use enum Style. Default is TILE.

Definition at line 183 of file SoImageBackground.h.

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

Inventor/nodes/SoImageBackground.h

Open Inventor Release 2024.2.1

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes