Open Inventor Reference
SoTexture2 Class Reference

Texture mapping node. More...

#include <Inventor/nodes/SoTexture2.h>

Inheritance diagram for SoTexture2:
SoNode SoFieldContainer SoBase

Public Types

enum  Model { MODULATE = GL_MODULATE , DECAL = GL_DECAL , BLEND = GL_BLEND }
 Texture model. More...
 
enum  Wrap { REPEAT = GL_REPEAT , CLAMP = GL_CLAMP }
 Texture wrap type. More...
 
- Public Types inherited from SoNode
enum  Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
 

Public Member Functions

 SoTexture2 ()
 Creates a texture node with default settings. More...
 
virtual void doAction (SoAction *action)
 This method performs the "typical" operation of a node for any action. More...
 
virtual void GLRender (SoGLRenderAction *action)
 These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing. More...
 
virtual void callback (SoCallbackAction *action)
 
- Public Member Functions inherited from SoNode
void setOverride (bool state)
 Turns override flag on or off. More...
 
bool isOverride () const
 Returns the state of the override flag. More...
 
SoNodecopy (bool copyConnections=FALSE) const
 Creates and returns an exact copy of the node. More...
 
virtual bool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal. More...
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
virtual void pick (SoPickAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
virtual void write (SoWriteAction *action)
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes. More...
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void grabEventsSetup ()
 These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()). More...
 
virtual void grabEventsCleanup ()
 
virtual void startNotify ()
 Initiates notification from an instance. More...
 
virtual void notify (SoNotList *list)
 Propagates modification notification through an instance. More...
 
SbNodeIdType getNodeId () const
 Returns the unique id for a node. More...
 
virtual SoChildListgetChildren () const
 Returns pointer to children, or NULL if none. More...
 
virtual void writeInstance (SoOutput *out)
 Writes instance to SoOutput. (Used for either stage of writing.) More...
 
virtual SoNodeaddToCopyDict () const
 Recursively adds this node and all nodes under it to the copy dictionary. More...
 
virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Copies the contents of the given node into this instance. More...
 
virtual SoFieldContainercopyThroughConnection () const
 Copies an instance that is encountered through a field connection. More...
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values. More...
 
bool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values. More...
 
bool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields. More...
 
void copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields. More...
 
bool 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 Inventor file format. More...
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
virtual int getFields (SoFieldList &list) const
 Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a pointer to the field with the given name. More...
 
bool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument. More...
 
bool enableNotify (bool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...
 
bool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed. More...
 
bool set (const char *fieldDataString, SoInput *dictIn)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. More...
 
void get (SbString &fieldDataString, SoOutput *dictOut)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
virtual void addWriteReference (SoOutput *out, bool isFromField=FALSE)
 Adds a reference to the instance when writing. More...
 
bool getIsBuiltIn () const
 Returns whether or not instance is considered 'built-in' to the library. More...
 
virtual const SoFieldDatagetFieldData () const
 Returns an SoFieldData structure for the node. More...
 
void addManagedSensor (SoSensor *sensor)
 Adds a sensor which is managed by the field container. More...
 
- Public Member Functions inherited from SoBase
void ref () const
 Adds and removes a reference to an instance. More...
 
void unref () const
 
void unrefNoDelete () const
 
void touch ()
 Marks an instance as modified, simulating a change to it. More...
 
virtual SoType getTypeId () const =0
 Returns the type identifier for a specific instance. More...
 
bool isOfType (SoType type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type. More...
 
virtual SbName getName () const
 Returns the name of an instance. More...
 
virtual void setName (const SbName &name)
 Sets the name of an instance. More...
 
void addAuditor (void *auditor, SoNotRec::Type type)
 Adds/removes an auditor to/from list. More...
 
void removeAuditor (void *auditor, SoNotRec::Type type)
 
const SoAuditorListgetAuditors ()
 Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...
 
int getRefCount () const
 Returns current reference count. More...
 
bool shouldWrite ()
 Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...
 

Static Public Member Functions

static void initClass ()
 
static bool readImage (const SbString &fname, int &w, int &h, int &nc, unsigned char *&bytes)
 Read libimage-format file. More...
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns type identifier for the SoNode class. More...
 
static SoNodegetByName (const SbName &name)
 Returns the last node given the specified name. More...
 
static int getByName (const SbName &name, SoNodeList &list)
 Returns the number of nodes with the given name, and adds to list pointers to those nodes. More...
 
static void initClass ()
 Initializes base node class. More...
 
static void initClasses ()
 Initialize ALL Inventor node classes. More...
 
static SbNodeIdType getNextNodeId ()
 Returns the next available unique id. More...
 
static int getActionMethodIndex (SoType t)
 Returns the index of this node in the action/method table, given its type. More...
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void initCopyDict ()
 During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. More...
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 Adds an instance to the dictionary. More...
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 If a copy of the given instance is in the dictionary, this returns it. More...
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, bool copyConnections)
 If a copy of the given instance is not in the dictionary, this returns NULL. More...
 
static void copyDone ()
 Cleans up the dictionary when done. More...
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void incrementCurrentWriteCounter ()
 Increments the current write counter at the start of a write operation. More...
 
static void decrementCurrentWriteCounter ()
 Decrements the current write counter after a write operation, in some rare cases. More...
 
static void addName (SoBase *, const char *)
 Internal methods used to maintain the global name dictionary. More...
 
static void removeName (SoBase *, const char *)
 
static SoBasegetNamedBase (const SbName &, SoType)
 Helper routines used to get stuff out of nameDict. More...
 
static int getNamedBases (const SbName &, SoBaseList &, SoType)
 
static bool read (SoInput *in, SoBase *&base, SoType expectedType)
 Reads one instance of some subclass of SoBase. More...
 
static void setInstancePrefix (const SbString &c)
 This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...
 

Public Attributes

SoSFString filename
 Fields. More...
 
SoSFImage image
 The texture. More...
 
SoSFEnum wrapS
 
SoSFEnum wrapT
 
SoSFEnum model
 
SoSFColor blendColor
 

Protected Member Functions

virtual bool readInstance (SoInput *in, unsigned short flags)
 Reads stuff into instance. Returns FALSE on error. More...
 
virtual ~SoTexture2 ()
 
int getReadStatus ()
 
void setReadStatus (int s)
 
- Protected Member Functions inherited from SoNode
 SoNode ()
 Constructor, destructor. More...
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer ()
 
 ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase ()
 Constructor is protected - this is an abstract class. More...
 
virtual ~SoBase ()
 Virtual destructor so that subclasses are deleted properly. More...
 
virtual void destroy ()
 Actually deletes an instance. More...
 
bool hasMultipleWriteRefs () const
 Returns TRUE if the instance has multiple write references. More...
 
bool writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
 Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName () const
 Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) More...
 

Additional Inherited Members

- Static Public Attributes inherited from SoBase
static bool traceRefs
 Turns on/off reference count tracing (for debugging) More...
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
 This set of enums is used when reading and writing the base. More...
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr ()
 This is used by the field-inheritence mechanism, hidden in the SoSubNode macros. More...
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter ()
 Returns current write counter. More...
 
- Protected Attributes inherited from SoNode
SbNodeIdType uniqueId
 Unique id for this node. More...
 
- Protected Attributes inherited from SoFieldContainer
bool isBuiltIn
 Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. More...
 
- Static Protected Attributes inherited from SoNode
static SbNodeIdType nextUniqueId
 Next available unique id. More...
 
static int nextActionMethodIndex
 Next index into the action method table. More...
 

Detailed Description

This property node defines a texture map and parameters for that map. This map is used to apply texture to subsequent shapes as they are rendered.

The texture can be read from the file specified by the filename field. Once the texture has been read, the image field contains the texture data. However, this field is marked so the image is not written out when the texture node is written to a file. To turn off texturing, set the filename field to an empty string ("").

Textures can also be specified in memory by setting the image field to contain the texture data. Doing so resets the filename to the empty string.

If the texture image's width or height is not a power of 2, or the image's width or height is greater than the maximum supported by OpenGL, then the image will be automatically scaled up or down to the next power of 2 or the maximum texture size. For maximum speed, point-sampling is used to do the scale; if you want more accurate resampling, pre-filter images to a power of 2 smaller than the maximum texture size (use the OpenGL glGetIntegerv(GL_MAX_TEXTURE_SIZE...) call to determine maximum texture for a specific OpenGL implementation).

The quality of the texturing is affected by the textureQuality field of the SoComplexity node. The textureQuality field affects what kind of filtering is done to the texture when it must be minified or magnified. The mapping of a particular texture quality value to a particular OpenGL filtering technique is implementation dependent, and varies based on the texturing performance. If mipmap filtering is required, mipmaps are automatically created using the simple box filter.

File Format/Default
Texture2 {
image 0 0 0
blendColor 0 0 0
}
SoSFEnum model
Definition: SoTexture2.h:166
SoSFColor blendColor
Definition: SoTexture2.h:167
SoSFEnum wrapT
Definition: SoTexture2.h:165
SoSFImage image
The texture.
Definition: SoTexture2.h:163
SoSFString filename
Fields.
Definition: SoTexture2.h:162
SoSFEnum wrapS
Definition: SoTexture2.h:164
Action Behavior
SoGLRenderAction, SoCallbackAction
Sets current texture in state.
See Also
SoComplexity, SoMaterial, SoTexture2Transform, SoTextureCoordinate2, SoTextureCoordinateBinding, SoTextureCoordinateFunction

Definition at line 143 of file SoTexture2.h.

Member Enumeration Documentation

◆ Model

Enumerator
MODULATE 
DECAL 
BLEND 

Definition at line 149 of file SoTexture2.h.

◆ Wrap

Enumerator
REPEAT 
CLAMP 

Definition at line 156 of file SoTexture2.h.

Constructor & Destructor Documentation

◆ SoTexture2()

SoTexture2::SoTexture2 ( )

◆ ~SoTexture2()

virtual SoTexture2::~SoTexture2 ( )
protectedvirtual

Member Function Documentation

◆ callback()

virtual void SoTexture2::callback ( SoCallbackAction action)
virtual

Reimplemented from SoNode.

◆ doAction()

virtual void SoTexture2::doAction ( SoAction action)
virtual

The default implementation does nothing.

Reimplemented from SoNode.

◆ getReadStatus()

int SoTexture2::getReadStatus ( )
inlineprotected

Definition at line 190 of file SoTexture2.h.

◆ GLRender()

virtual void SoTexture2::GLRender ( SoGLRenderAction action)
virtual

Reimplemented from SoNode.

◆ initClass()

static void SoTexture2::initClass ( )
static

◆ readImage()

static bool SoTexture2::readImage ( const SbString fname,
int &  w,
int &  h,
int &  nc,
unsigned char *&  bytes 
)
static

◆ readInstance()

virtual bool SoTexture2::readInstance ( SoInput in,
unsigned short  flags 
)
protectedvirtual

Reimplemented from SoFieldContainer.

◆ setReadStatus()

void SoTexture2::setReadStatus ( int  s)
inlineprotected

Definition at line 191 of file SoTexture2.h.

Member Data Documentation

◆ blendColor

SoSFColor SoTexture2::blendColor

Definition at line 167 of file SoTexture2.h.

◆ filename

SoSFString SoTexture2::filename

file to read texture from

Definition at line 162 of file SoTexture2.h.

◆ image

SoSFImage SoTexture2::image

Definition at line 163 of file SoTexture2.h.

◆ model

SoSFEnum SoTexture2::model

Definition at line 166 of file SoTexture2.h.

◆ wrapS

SoSFEnum SoTexture2::wrapS

Definition at line 164 of file SoTexture2.h.

◆ wrapT

SoSFEnum SoTexture2::wrapT

Definition at line 165 of file SoTexture2.h.


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