SoImageBackground Class Reference
[Backgrounds]

Image background node. More...

#include <Inventor/nodes/SoImageBackground.h>

Inheritance diagram for SoImageBackground:

List of all members.

Public Types
enum	Style {   NONE,   CENTER,   LOWER_LEFT,   UPPER_LEFT,   UPPER_RIGHT,   LOWER_RIGHT,   STRETCH,   TILE,   CROP,   FIT }
Public Member Functions
virtual SoType	getTypeId () const
	SoImageBackground ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFFilePathString	filename
SoSFImage	image
SoSFEnum	style

---

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

ImageBackground {

filename	""
image	0 0 0 0
style	TILE

}

ACTION BEHAVIOR

SoGLRenderAction
Renders background, does not affect state.

SEE ALSO

SoBackground, SoGradientBackground

See related examples:

BackgroundNode, MedicalBonesMuscles, BonesMuscles

---

Member Enumeration Documentation

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).

---

Constructor & Destructor Documentation

SoImageBackground::SoImageBackground

(

)

Creates a background image node with default settings.

---

Member Function Documentation

static SoType SoImageBackground::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoBackground.

virtual SoType SoImageBackground::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoBackground.

---

Member Data Documentation

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).

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.

SoSFEnum SoImageBackground::style

Specifies how the image will be mapped onto the window.

Use enum Style. Default is TILE.

---

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

• Inventor/nodes/SoImageBackground.h