Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoTextureUnit Class Reference

VSG extension Node that specifies the current texture unit and the associated mapping method. More...

#include <Inventor/nodes/SoTextureUnit.h>

+ Inheritance diagram for SoTextureUnit:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoTextureUnit ()
 Constructor.
 
- 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 SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 unsigned int getMaxTextureUnit (SoState *state=NULL)
 Returns the maximum number of texture units.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (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

SoSFUInt32 unit
 Specifies the texture unit identifier.
 

Detailed Description

VSG extension Node that specifies the current texture unit and the associated mapping method.

This node specifies the current texture unit for all subsequent 2D and 3D texture nodes (for example, SoTexture2, SoTexture2Transform, SoTextureCoordinate2, SoTextureCoordinateBinding, and SoTextureCoordinateFunction).

If the graphics board supports multitexturing (OpenGL 1.5 or GL_ARB_multitexture extension), then multiple textures, each defined by a texture unit, can be applied to the same shape. The maximum number of texture units depends on the board and can be queried using getMaxTextureUnit.

Multitexturing is supported by the following shapes:

Each texture unit is defined by the following texture properties:

Limitations:

  • Multitexturing is not supported for non convex shapes (SoShapeHints::UNKNOWN_FACE_TYPE).
  • Automatic texture coordinate generation (SoTextureCoordinateFunction) is not possible for the bump mapping method.
  • When not using shaders, only units 0 to 3 can be used.
  • When using shaders, texture unit properties (listed above) can be defined for units 0 to 7. When shaders are used, it is also possible to use SoVertexShaderParameter to specify texture coordinates to be used by the shader(s). SoVertexShaderParameter parameter sets are limited to 32 on OpenGL3 hardware.

FILE FORMAT/DEFAULT

    TextureUnit {
    unit 0
    }

ACTION BEHAVIOR

SEE ALSO

SoBumpMappingProperty, SoTexture2, SoTexture2Transform, SoTextureCoordinate2, SoTextureCoordinateBinding, SoTextureCoordinateFunction.

Definition at line 112 of file SoTextureUnit.h.

Constructor & Destructor Documentation

◆ SoTextureUnit()

SoTextureUnit::SoTextureUnit ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoTextureUnit::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getMaxTextureUnit()

static unsigned int SoTextureUnit::getMaxTextureUnit ( SoState state = NULL)
static

Returns the maximum number of texture units.

This is the max which can be used when a shader is on state. Without shaders, only the first 4 units (0..3) can be used.

◆ getTypeId()

virtual SoType SoTextureUnit::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ unit

SoSFUInt32 SoTextureUnit::unit

Specifies the texture unit identifier.

Can range from 0 to the largest texture unit, which is getMaxTextureUnit()-1. Values greater than the largest texture unit are clamped at the largest texture unit.

Definition at line 124 of file SoTextureUnit.h.


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