This abstract node type is the base type for all node types which specify 3D sources for texture images. More...

#include <H3D/X3DTexture3DNode.h>

Inheritance diagram for H3D::X3DTexture3DNode:

Classes
class	SFImage
	A SFNode encapsulating an Image class. More...

Public Types
typedef DependentSFNode< FieldRef< TextureProperties, Field, &TextureProperties::propertyChanged > >	SFTextureProperties
	The SFTextureProperties is dependent on the propertyChanged field of the contained TextureProperties.

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.

Public Member Functions
	X3DTexture3DNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< SFBool > _repeatS=0, Inst< SFBool > _repeatT=0, Inst< SFBool > _repeatR=0, Inst< SFBool > _scaleToP2=0, Inst< SFImage > _image=0, Inst< SFTextureProperties > _textureProperties=0, Inst< UpdateSaveToURL > _saveToUrl=0, Inst< SFBool > _saveSuccess=0, Inst< SFInt32 > _saveHeight=0, Inst< SFInt32 > _saveWidth=0)
	Constructor.

virtual void	render ()
	Performs the OpenGL rendering required to install the image as a texture.

virtual void	renderTextureProperties ()
	Render all OpenGL texture properties.

virtual GLint	glInternalFormat (Image *_image)
	Returns the internal OpenGL format to use given an Image.

virtual void	enableTexturing ()
	Virtual function for making all OpenGL calls that are needed to enable texturing for the texture.

virtual void	disableTexturing ()
	Virtual function for making all OpenGL calls that are needed to disable texturing for the texture.

virtual GLuint64	getTextureHandle ()
	Get the bindless texture handle.

virtual Vec3f	textureSize ()
	Sometimes the texture represents a volume in space, e.g. More...

virtual void	glTexImage (Image *_image, GLenum _texture_target, bool scale_to_power_of_two)
	Installs the given image as a OpenGL texture with a call to the glTexImage3D function. More...

virtual void	renderSubImage (Image *_image, GLenum _texture_target, int xoffset, int yoffset, int z_offset, int width, int height, int depth)
	Replaces part of the current texture from an image.

virtual void	setTextureWidth (int _width)
	Set the texture width.

virtual void	setTextureHeight (int _height)
	Set the texture height.

virtual void	setTextureDepth (int _depth)
	Set the texture depth.

virtual GLenum	glPixelFormat (Image *_image)
	Returns the OpenGL pixel format to use given an Image, e.g.

Public Member Functions inherited from H3D::H3DSingleTextureNode
	H3DSingleTextureNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< UpdateSaveToURL > _saveToUrl=0, Inst< SFBool > _saveSuccess=0, Inst< SFInt32 > _saveHeight=0, Inst< SFInt32 > _saveWidth=0)
	Constructor.

virtual	~H3DSingleTextureNode ()
	Destructor.

virtual GLuint	getTextureId ()
	Get the OpenGL texture id that is used for this texture.

virtual GLuint	getTextureUnit ()
	Get the OpenGL texture unit that is used for this texture.

virtual GLenum	getTextureTarget ()
	Get the OpenGL texture target that is used for this texture.

virtual int	getTextureWidth ()
	Get the texture width.

virtual int	getTextureHeight ()
	Get the texture height.

virtual int	getTextureDepth ()
	Get the texture depth.

virtual void	setTextureId (GLuint _id)
	Set the OpenGL texture id that is used for this texture.

virtual void	setTextureUnit (GLint unit)
	Set the OpenGL texture unit that is used for this texture.

virtual void	setTextureTarget (GLenum target)
	Set the OpenGL texture target that is used for this texture.

virtual bool	makeResident ()
	{ Bindless texturing functions More...

virtual void	makeNonResident ()
	Make the texture non-resident.

virtual bool	isResident ()
	Returns true if the texture is resident in GPU memory or false otherwise.

virtual void	invalidateTextureHandle ()
	This should be called if the texture object is to be replaced. More...

void	addShaderField (Field &_field)
	Add a shader field which contains this texture node. More...

void	removeShaderField (Field &_field)
	Remove a shader field which contains this texture node. More...

virtual void	inUse ()
	Call to signify that this texture is currently in use. More...

Public Member Functions inherited from H3D::X3DTextureNode
	X3DTextureNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< UpdateSaveToURL > _saveToUrl=0, Inst< SFBool > _saveSuccess=0, Inst< SFInt32 > _saveHeight=0, Inst< SFInt32 > _saveWidth=0)
	Constructor.

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

virtual void	preRender ()
	This function will be called by the X3DShapeNode before any rendering of geometry and before the call to the render function.

virtual void	postRender ()
	This function will be called by the X3DShapeNode after the geometry has been rendered to restore the states to what it was before the call to preRender().

virtual GLbitfield	getAffectedGLAttribs ()
	Returns a bitmask of the OpenGL attrib bits that will be affected by this node. More...

virtual GLuint	renderImage (Image *image, GLenum texture_target, bool scale_to_power_of_two)
	Installs the image as a OpenGL texture. More...

virtual GLenum	glPixelComponentType (Image *image)
	Returns the OpenGL pixel compnent type to use given an Image, e.g. More...

virtual Image *	renderToImage (H3DInt32 _width, H3DInt32 _height, bool output_float_texture=false)
	Create a new Image object which contains the result of rendering this texture. More...

Public Member Functions inherited from H3D::X3DAppearanceChildNode
	X3DAppearanceChildNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0)
	Constructor.

Public Member Functions inherited from H3D::X3DNode
	X3DNode (Inst< SFNode > _metadata=0)
	Constructor.

X3DMetadataObject *	getMetadataByName (const string &_name)
	Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. 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	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 Member Functions inherited from H3D::H3DDisplayListObject
	H3DDisplayListObject (Inst< DisplayList > _displayList=0)
	Constructor.

Public Member Functions inherited from H3D::H3DImageObject
	H3DImageObject (Inst< SFImage > _image=0)
	Constructor.

Public Attributes
H3DUniquePtr< SFBool >	repeatS
	If true the texture will repeat itself when the s texture coordinate is outside the range [0,1]. More...

H3DUniquePtr< SFBool >	repeatT
	If true the texture will repeat itself when the t texture coordinate is outside the range [0,1]. More...

H3DUniquePtr< SFBool >	repeatR
	If true the texture will repeat itself when the r texture coordinate is outside the range [0,1]. More...

H3DUniquePtr< SFBool >	scaleToPowerOfTwo
	If true the image used will be scaled so that the dimensions are a power of two if they are not. More...

H3DUniquePtr< SFTextureProperties >	textureProperties
	The textureProperties field contains a TextureProperties node which allows fine control over a texture's application. More...

Public Attributes inherited from H3D::X3DTextureNode
H3DUniquePtr< UpdateSaveToURL >	saveToUrl
	When a new value is specified for saveToUrl the current texture is rendered to a buffer and saved to the specified filename. More...

H3DUniquePtr< SFBool >	saveSuccess
	Contains the result of the last save operation. More...

H3DUniquePtr< SFInt32 >	saveHeight
	The height of the image to write to file when the saveToUrl field is used. More...

H3DUniquePtr< SFInt32 >	saveWidth
	The width of the image to write to file when the saveToUrl field is used. More...

Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNode >	metadata
	Meta data about the node. More...

Public Attributes inherited from H3D::H3DDisplayListObject
H3DUniquePtr< DisplayList >	displayList
	The DisplayList instance handling the OpenGL caching of this object.

Public Attributes inherited from H3D::H3DImageObject
H3DUniquePtr< SFImage >	image
	Field containing the Image to use as a texture.

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

Static Public Attributes inherited from H3D::X3DTextureNode
static bool	load_images_in_separate_thread = true
	This is the default value for the GlobalSettings::loadTexturesInThread field. More...

static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Protected Member Functions
virtual std::pair< H3DInt32, H3DInt32 >	getDefaultSaveDimensions ()
	Returns the default dimensions to use when this texture is saved to file. More...

Protected Member Functions inherited from H3D::X3DTextureNode
GLint	glCompressedInternalFormat (GLint _format, const std::string &_compression)
	Given a non-compressed internal format, return an equivelent compressed format based on the compression settings. More...

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

Protected Attributes
H3DUniquePtr< Field >	imageUpdated
	Field to indicate image changed C++ only field.

H3DUniquePtr< Field >	textureUpdated
	Field which is used to trigger an update of the texture when it has been modified through some functions. More...

H3DUniquePtr< UpdateTextureProperties >	updateTextureProperties
	Field that will make sure that the texture properties changes are transferred to the texture when changed. More...

Protected Attributes inherited from H3D::H3DSingleTextureNode
GLuint64	texture_handle
	The texture handle (GPU)

GLuint	texture_id
	The OpenGL texture id of the installed texture, 0 if not installed.

GLint	texture_unit
	The OpenGL texture unit that is used to render this texture. More...

GLenum	texture_target
	The OpenGL texture target that is used to render this texture.

int	texture_width
	texture width

int	texture_height
	texture height

int	texture_depth
	texture depth

Field::FieldVector	shader_fields
	Shader fields which contain this texture.

H3DTime	last_used
	Time-stamp at which this texture was last used.

bool	is_resident
	True if this texture is currently resident.

Additional Inherited Members
Static Public Member Functions inherited from H3D::H3DSingleTextureNode
static void	makeUnusedTexturesNonResident (H3DTime _unusedTime)
	Look at all resident textures and make those that have not been used recently non-resident. More...

Static Public Member Functions inherited from H3D::X3DTextureNode
static X3DTextureNode *	getActiveTexture ()
	Gets the currently active texture, i.e. More...

static void	setActiveTexture (X3DTextureNode *t)
	Set the active texture. More...

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 Types inherited from H3D::H3DSingleTextureNode
typedef std::vector< H3DSingleTextureNode * >	TextureVector
	}

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

Static Protected Attributes inherited from H3D::H3DSingleTextureNode
static TextureVector	resident_textures
	List of all currently resident textures.

Detailed Description

This abstract node type is the base type for all node types which specify 3D sources for texture images.

Internal routes:

Member Function Documentation

◆ getDefaultSaveDimensions()

std::pair< H3DInt32, H3DInt32 > X3DTexture3DNode::getDefaultSaveDimensions ( )

protectedvirtual

Returns the default dimensions to use when this texture is saved to file.

Returns the x, y dimensions of the Image object

Reimplemented from H3D::X3DTextureNode.

References H3D::X3DTextureNode::getDefaultSaveDimensions(), H3DUtil::Image::height(), H3D::H3DImageObject::image, and H3DUtil::Image::width().

◆ glTexImage()

void X3DTexture3DNode::glTexImage	(	Image *	_image,
		GLenum	_texture_target,
		bool	scale_to_power_of_two
	)

virtual

Installs the given image as a OpenGL texture with a call to the glTexImage3D function.

This function is used by renderImage () and uses the glInternalFormat (), glPixelFormat () and glPixelComponentType () functions to get the arguments to the glTexImage3D call.

Reimplemented from H3D::X3DTextureNode.

References H3DUtil::Image::bitsPerPixel(), H3D::TextureProperties::borderWidth, H3DUtil::Image::byteAlignment(), H3DUtil::Image::compressionType(), H3DUtil::Image::depth(), H3D::TextureProperties::generateMipMaps, H3D::GlobalSettings::getActive(), H3DUtil::Image::getImageData(), H3DUtil::RefCountedClass::getName(), H3D::GlobalSettings::getOptionNode(), glInternalFormat(), H3D::X3DTextureNode::glPixelComponentType(), glPixelFormat(), H3DUtil::Image::height(), isPowerOfTwo(), H3D::GraphicsOptions::maxTextureDimension, nextPowerOfTwo(), textureProperties, H3D::TextureProperties::textureTransferBias, H3D::TextureProperties::textureTransferScale, Vec4f(), and H3DUtil::Image::width().

◆ textureSize()

virtual Vec3f H3D::X3DTexture3DNode::textureSize ( )

inlinevirtual

Sometimes the texture represents a volume in space, e.g.

when it contains volume data to be rendered. This function returns the size of the space the volume occupies in metres.

Reimplemented from H3D::X3DTextureNode.

References H3DUtil::Image::depth(), H3DUtil::Image::height(), H3DUtil::Image::pixelSize(), and H3DUtil::Image::width().

Member Data Documentation

◆ repeatR

H3DUniquePtr< SFBool > H3D::X3DTexture3DNode::repeatR

If true the texture will repeat itself when the r texture coordinate is outside the range [0,1].

If false the texture will be clamped if outside the same range.

Access type: inputOutput
Default value: FALSE

Referenced by renderTextureProperties(), and X3DTexture3DNode().

◆ repeatS

H3DUniquePtr< SFBool > H3D::X3DTexture3DNode::repeatS

If true the texture will repeat itself when the s texture coordinate is outside the range [0,1].

If false the texture will be clamped if outside the same range.

Access type: inputOutput
Default value: FALSE

Referenced by renderTextureProperties(), and X3DTexture3DNode().

◆ repeatT

H3DUniquePtr< SFBool > H3D::X3DTexture3DNode::repeatT

If true the texture will repeat itself when the t texture coordinate is outside the range [0,1].

If false the texture will be clamped if outside the same range.

Access type: inputOutput
Default value: FALSE

Referenced by renderTextureProperties(), and X3DTexture3DNode().

◆ scaleToPowerOfTwo

H3DUniquePtr< SFBool > H3D::X3DTexture3DNode::scaleToPowerOfTwo

If true the image used will be scaled so that the dimensions are a power of two if they are not.

This will however take up more memory and might cause some unwanted strething effects on the texture. The new texture values will be linearly interpolated from the original ones.

If the graphics card supports non-power of two textures, then no scaling is performed, regardless of this option.

Access type: inputOutput
Default value: FALSE

Referenced by render(), and X3DTexture3DNode().

◆ textureProperties

H3DUniquePtr< SFTextureProperties > H3D::X3DTexture3DNode::textureProperties

The textureProperties field contains a TextureProperties node which allows fine control over a texture's application.

Access type: inputOutput

Referenced by H3D::FrameBufferTextureGenerator::createOutputTextures(), glInternalFormat(), glPixelFormat(), glTexImage(), renderSubImage(), renderTextureProperties(), and X3DTexture3DNode().

◆ textureUpdated

H3DUniquePtr< Field > H3D::X3DTexture3DNode::textureUpdated

protected

Field which is used to trigger an update of the texture when it has been modified through some functions.

C++ only field.

Referenced by setTextureDepth(), setTextureHeight(), setTextureWidth(), and X3DTexture3DNode().

◆ updateTextureProperties

H3DUniquePtr< UpdateTextureProperties > H3D::X3DTexture3DNode::updateTextureProperties

protected

Field that will make sure that the texture properties changes are transferred to the texture when changed.

C++ only field

Referenced by render(), and X3DTexture3DNode().

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

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDefaultSaveDimensions()

◆ glTexImage()

◆ textureSize()

Member Data Documentation

◆ repeatR

◆ repeatS

◆ repeatT

◆ scaleToPowerOfTwo

◆ textureProperties

◆ textureUpdated

◆ updateTextureProperties