H3D API  2.4.1
Classes | Public Attributes | Static Public Attributes | Protected Attributes | List of all members
H3D::ImageObjectInfo Class Reference

This node can be used to get information about dimensions, sizes pixel types etc from H3DImageObject nodes such as Image3DTexture. More...

#include <H3D/ImageObjectInfo.h>

Inheritance diagram for H3D::ImageObjectInfo:
Inheritance graph

Classes

class  SFImageObjectNode
 An SFNode where we make sure the type of the nodes contained is a subclass of H3DImageObject. More...
 
class  UpdateFields
 Field for updating the output fields when the image object changes value. More...
 

Public Attributes

H3DUniquePtr< SFImageObjectNodetexture
 The texture field contains the image object we want to get information from. More...
 
H3DUniquePtr< SFVec3fpixelSize
 The size of each pixel/voxel in the image object in metres. More...
 
H3DUniquePtr< SFInt32width
 The width of the image object in pixels. More...
 
H3DUniquePtr< SFInt32height
 The height of the image object in pixels. More...
 
H3DUniquePtr< SFInt32depth
 The depth of the image object in pixels. More...
 
H3DUniquePtr< SFStringpixelType
 The type of each pixel element in the image object. More...
 
H3DUniquePtr< SFStringpixelComponentType
 The type of each component of the pixel. More...
 
H3DUniquePtr< SFInt32bitsPerPixel
 The number of bits used for each pixel. More...
 
H3DUniquePtr< SFVec3ftotalSize
 The total size of the volume in metres, i.e. More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 

Static Public Attributes

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

Protected Attributes

H3DUniquePtr< UpdateFieldsupdate_fields
 The field used to update the other fields.
 

Additional Inherited Members

- 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 inherited from H3D::X3DChildNode
 X3DChildNode (Inst< SFNode > _metadata=0)
 Constructor.
 
- Public Member Functions inherited from H3D::X3DNode
 X3DNode (Inst< SFNode > _metadata=0)
 Constructor.
 
X3DMetadataObjectgetMetadataByName (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 Nodeclone (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.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 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 string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
virtual FieldgetField (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...
 
- 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 NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

This node can be used to get information about dimensions, sizes pixel types etc from H3DImageObject nodes such as Image3DTexture.

Examples:

Member Data Documentation

◆ bitsPerPixel

H3DUniquePtr< SFInt32 > H3D::ImageObjectInfo::bitsPerPixel

The number of bits used for each pixel.

Access type: outputOnly

◆ depth

H3DUniquePtr< SFInt32 > H3D::ImageObjectInfo::depth

The depth of the image object in pixels.

Access type: outputOnly

◆ height

H3DUniquePtr< SFInt32 > H3D::ImageObjectInfo::height

The height of the image object in pixels.

Access type: outputOnly

◆ pixelComponentType

H3DUniquePtr< SFString > H3D::ImageObjectInfo::pixelComponentType

The type of each component of the pixel.

Valid values are:

  • "SIGNED"
  • "UNSIGNED"
  • "RATIONAL"

Access type: outputOnly

◆ pixelSize

H3DUniquePtr< SFVec3f > H3D::ImageObjectInfo::pixelSize

The size of each pixel/voxel in the image object in metres.

Access type: outputOnly

◆ pixelType

H3DUniquePtr< SFString > H3D::ImageObjectInfo::pixelType

The type of each pixel element in the image object.

Valid values are:

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

Access type: outputOnly

◆ texture

H3DUniquePtr< SFImageObjectNode > H3D::ImageObjectInfo::texture

The texture field contains the image object we want to get information from.

Access type: inputOutput

◆ totalSize

H3DUniquePtr< SFVec3f > H3D::ImageObjectInfo::totalSize

The total size of the volume in metres, i.e.

Vec3f( width * pixel_size.x, height * pixel_size.y, depth * pixel_size.z )

Access type: outputOnly

◆ width

H3DUniquePtr< SFInt32 > H3D::ImageObjectInfo::width

The width of the image object in pixels.

Access type: outputOnly


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