The RawImageLoader loads a raw data file and lets the user specify the parameters for the values directly. More...

#include <H3D/RawImageLoader.h>

Inheritance diagram for H3D::RawImageLoader:

Public Member Functions
	RawImageLoader (Inst< SFInt32 > _width=0, Inst< SFInt32 > _height=0, Inst< SFInt32 > _depth=0, Inst< SFString > _pixelType=0, Inst< SFString > _pixelComponentType=0, Inst< SFInt32 > _bitsPerPixel=0, Inst< SFVec3f > _pixelSize=0)
	Constructor.

virtual Image *	loadImage (const string &url)
	Loads the image from the url and returns a PixelImage with the data loaded from the file/.

Public Member Functions inherited from H3D::H3DImageLoaderNode
	H3DImageLoaderNode ()
	Constructor.

virtual Image *	loadImage (istream &)
	Load an image from an istream. More...

virtual string	defaultXMLContainerField ()
	Returns the default xml containerField attribute value. More...

Public Member Functions inherited from H3D::Node
	Node ()
	Constructor.

virtual Node *	clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
	Returns a new instance of this node type with the same state as this one. More...

virtual	~Node ()
	Destructor.

X3DPrototypeInstance *	getProtoInstanceParent ()
	If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...

void	setProtoInstanceParent (X3DPrototypeInstance *p)
	Set the X3DPrototypeInstance this node is the the root node if applicaple.

virtual void	render ()
	the render() function is used for the depth-first rendering traversal of the scene-graph. More...

virtual void	traverseSG (TraverseInfo &ti)
	traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...

virtual bool	lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
	Detect intersection between a line segment and the Node. More...

virtual void	closestPoint (const Vec3f &p, NodeIntersectResult &result)
	Find closest point on Node to p. More...

virtual bool	movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
	Detect collision between a moving sphere and the Node. More...

virtual Field *	getField (const string &_name) const
	return a pointer to the field specified by name within this instance

int	addDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

int	removeDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

Public Attributes
H3DUniquePtr< SFInt32 >	width
	The width of the image in pixels. More...

H3DUniquePtr< SFInt32 >	height
	The height of the image in pixels. More...

H3DUniquePtr< SFInt32 >	depth
	The height of the image in pixels. More...

H3DUniquePtr< SFString >	pixelType
	The type of each pixel element in the image. More...

H3DUniquePtr< SFString >	pixelComponentType
	The type of each component of the pixel. More...

H3DUniquePtr< SFInt32 >	bitsPerPixel
	The number of bits per pixel. More...

H3DUniquePtr< SFVec3f >	pixelSize
	The size of the pixel in metres. More...

Static Public Attributes
static H3DNodeDatabase	database
	The H3DNodeDatabase for this Node.

Additional Inherited Members
Public Types inherited from H3D::H3DImageLoaderNode
typedef bool(*	SupportsFileFunc) (const string &url)
	Function ptr type for callback to ask if loader supports a url.

typedef bool(*	SupportsStreamFunc) (istream &is)
	Function ptr type for callback to ask if loader supports a stream.

Public Types inherited from H3D::Node
typedef std::map< Node , Node >	DeepCopyMap
	A map type used during a deep copy clone() to map from original nodes to cloned nodes.

Static Public Member Functions inherited from H3D::H3DImageLoaderNode
static H3DImageLoaderNode *	getSupportedFileReader (const string &url)
	Given an url to a file, it returns an instance of a H3DImageLoaderNode class that can handle that file type. More...

static H3DImageLoaderNode *	getSupportedFileReader (istream &is)
	Given an istream, it returns an instance of a H3DImageLoaderNode class that can handle that image type. More...

static void	registerFileReader (const string &name, CreateNodeFunc create, SupportsFileFunc supports, SupportsStreamFunc supports_stream=NULL)
	Register a file reader that can then be returned by getSupportedFileReader(). More...

static void	registerFileReader (const FileReaderRegistration &fr)
	Register a file reader that can then be returned by getSupportedFileReader().

Static Public Member Functions inherited from H3D::Node
static unsigned int	nrNodesAlive ()
	Returns the nr of nodes currently alive, i.e. nodes created but not destructed.

static int	nrNodesCreated ()
	Returns the number of nodes created in total since the start of the program.

Protected Member Functions inherited from H3D::Node
void	cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for the clone() method. More...

Static Protected Member Functions inherited from H3D::Node
static Node *	getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for nodes that implement clone() More...

Detailed Description

The RawImageLoader loads a raw data file and lets the user specify the parameters for the values directly.

The width, height and depth fields specify the number of pixels in each dimension. The pixelType field specifies the type of each pixel in the image. Valid values are:

"LUMINANCE"
"LUMINANCE_ALPHA"
"RGB"
"RGBA"
"BGR"
"BGRA"
"VEC3" The pixelComponentType specifies the type of each component of the pixel, e.g. if pixelType is RGB, pixelComponentType specifies what type of value the components R, G and B are. Valid values are:
"SIGNED"
"UNSIGNED"
"RATIONAL" The bitsPerPixel specifies how many bits a pixel takes in memory. The pixelSize field is an optional field that specifies the size of each pixel in meters. This can be used for e.g. volume rendering components to know the image size in space.

This loader can also automatically detect and decompress gzip packaged data

Examples:

RawImageLoader.x3d ( Source )
ImageLoaders.x3d ( Source )

Member Data Documentation

◆ bitsPerPixel

H3DUniquePtr< SFInt32 > H3D::RawImageLoader::bitsPerPixel

The number of bits per pixel.

Access type: inputOutput
Default value: "24"

Referenced by loadImage(), and RawImageLoader().

◆ depth

H3DUniquePtr< SFInt32 > H3D::RawImageLoader::depth

The height of the image in pixels.

Access type: inputOutput
Default value: 1

Referenced by loadImage(), and RawImageLoader().

◆ height

H3DUniquePtr< SFInt32 > H3D::RawImageLoader::height

The height of the image in pixels.

Access type: inputOutput
Default value: 1

Referenced by loadImage(), and RawImageLoader().

◆ pixelComponentType

H3DUniquePtr< SFString > H3D::RawImageLoader::pixelComponentType

The type of each component of the pixel.

Valid values are:

"SIGNED"
"UNSIGNED"
"RATIONAL"

Access type: inputOutput
Default value: "UNSIGNED"

Referenced by loadImage(), and RawImageLoader().

◆ pixelSize

H3DUniquePtr< SFVec3f > H3D::RawImageLoader::pixelSize

The size of the pixel in metres.

Access type: inputOutput
Default value: "Vec3f( 0, 0, 0 )"

Referenced by loadImage(), and RawImageLoader().

◆ pixelType

H3DUniquePtr< SFString > H3D::RawImageLoader::pixelType

The type of each pixel element in the image.

Valid values are:

"LUMINANCE"
"LUMINANCE_ALPHA"
"RGB"
"RGBA"
"BGR"
"BGRA"
"VEC3"

Access type: inputOutput
Default value: "RGB"

Referenced by loadImage(), and RawImageLoader().

◆ width

H3DUniquePtr< SFInt32 > H3D::RawImageLoader::width

The width of the image in pixels.

Access type: inputOutput
Default value: 1

Referenced by loadImage(), and RawImageLoader().

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

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Data Documentation

◆ bitsPerPixel

◆ depth

◆ height

◆ pixelComponentType

◆ pixelSize

◆ pixelType

◆ width