NAME¶

SoTextureImageElement - The SoTextureImageElement class is yet to be documented. FIXME: write doc.

SYNOPSIS¶

#include <Inventor/elements/SoTextureImageElement.h> Inherits SoReplacedElement. Inherited by SoGLTextureImageElement.

Public Types¶

enum Model { BLEND = 0x0be2, MODULATE = 0x2100, DECAL = 0x2101, REPLACE = 0x1E01 } enum Wrap { CLAMP = 0x2900, REPEAT = 0x2901, CLAMP_TO_BORDER = 0x812D }

Public Member Functions¶

virtual void init (SoState *state) FIXME: write doc.

Static Public Member Functions¶

static SoType getClassTypeId (void) static int getClassStackIndex (void) static void * createInstance (void) static void initClass (void) static void setDefault (SoState *const state, SoNode *const node) static void set (SoState *const state, SoNode *const node, const SbVec2s &size, const int numComponents, const unsigned char * bytes, const int wrapS, const int wrapT, const int model, const SbColor &blendColor) static void set (SoState *const state, SoNode *const node, const SbVec3s &size, const int numComponents, const unsigned char * bytes, const int wrapS, const int wrapT, const int wrapR, const int model, const SbColor &blendColor) static void set (SoState *const state, SoNode *const node, const SbVec2s &size, const int numComponents, const unsigned char * bytes, const Wrap wrapS, const Wrap wrapT, const Model model, const SbColor & blendColor) static void set (SoState *const state, SoNode *const node, const SbVec3s &size, const int numComponents, const unsigned char * bytes, const Wrap wrapS, const Wrap wrapT, const Wrap wrapR, const Model model, const SbColor &blendColor) static const unsigned char * get (SoState *const state, SbVec2s & size, int &numComponents, Wrap & wrapS, Wrap &wrapT, Model &model, SbColor &blendColor) FIXME: write doc. static const unsigned char * get (SoState *const state, SbVec3s &size, int &numComponents, Wrap &wrapS, Wrap &wrapT, Wrap &wrapR, Model &model, SbColor &blendColor) static const unsigned char * get (SoState *const state, SbVec2s & size, int &numComponents, int &wrapS, int & wrapT, int &model, SbColor & blendColor) static const unsigned char * get (SoState *const state, SbVec3s & size, int &numComponents, int &wrapS, int & wrapT, int &wrapR, int &model, SbColor &blendColor) static const SbColor & getBlendColor (SoState *const state) static const unsigned char * getImage (SoState *const state, SbVec2s & size, int &numComponents) static const unsigned char * getImage (SoState *const state, SbVec3s & size, int &numComponents) static Model getModel (SoState *const state) static Wrap getWrapS (SoState *const state) static Wrap getWrapT (SoState *const state) static Wrap getWrapR (SoState *const state) static SbBool containsTransparency (SoState *const state) FIXME: write doc. static const unsigned char * getDefault (SbVec2s & size, int &numComponents) FIXME: write doc. static const unsigned char * getDefault (SbVec3s & size, int &numComponents)

Protected Member Functions¶

virtual ~SoTextureImageElement () virtual void setElt (const SbVec2s &size, const int numComponents, const unsigned char * bytes, const Wrap wrapS, const Wrap wrapT, const Model model, const SbColor &blendColor) FIXME: write doc. virtual void setElt (const SbVec3s &size, const int numComponents, const unsigned char *bytes, const Wrap wrapS, const Wrap wrapT, const Wrap wrapR, const Model model, const SbColor & blendColor) virtual SbBool hasTransparency (void) const

Protected Attributes¶

SbVec3s size int numComponents const unsigned char * bytes Wrap wrapS Wrap wrapT Wrap wrapR Model model SbColor blendColor

Additional Inherited Members¶

Detailed Description¶

The SoTextureImageElement class is yet to be documented. FIXME: write doc.

Member Enumeration Documentation¶

enum SoTextureImageElement::Model¶

FIXME: write doc.

enum SoTextureImageElement::Wrap¶

FIXME: write doc.

Constructor & Destructor Documentation¶

SoTextureImageElement::~SoTextureImageElement () [protected], [virtual]¶

The destructor.

Member Function Documentation¶

SoType SoTextureImageElement::getClassTypeId (void) [static]¶

This static method returns the class type. Reimplemented from SoReplacedElement. Reimplemented in SoGLTextureImageElement.

int SoTextureImageElement::getClassStackIndex (void) [static]¶

This static method returns the state stack index for the class. Reimplemented from SoReplacedElement. Reimplemented in SoGLTextureImageElement.

void * SoTextureImageElement::createInstance (void) [static]¶

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Reimplemented in SoGLTextureImageElement.

void SoTextureImageElement::initClass (void) [static]¶

This static method initializes static data for the SoTextureImageElement class. Reimplemented from SoReplacedElement. Reimplemented in SoGLTextureImageElement.

void SoTextureImageElement::setDefault (SoState *conststate, SoNode *constnode) [static]¶

Resets this element to its original values.

void SoTextureImageElement::set (SoState *conststate, SoNode *constnode, const SbVec2s &size, const intnumComponents, const unsigned char *bytes, const intwrapS, const intwrapT, const intmodel, const SbColor &blendColor) [static]¶

FIXME: write doc.

void SoTextureImageElement::set (SoState *conststate, SoNode *constnode, const SbVec3s &size, const intnumComponents, const unsigned char *bytes, const intwrapS, const intwrapT, const intwrapR, const intmodel, const SbColor &blendColor) [static]¶

FIXME: write doc. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

const unsigned char * SoTextureImageElement::get (SoState *conststate, SbVec3s &size, int &numComponents, Wrap &wrapS, Wrap &wrapT, Wrap &wrapR, Model &model, SbColor &blendColor) [static]¶

FIXME: write doc. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

const unsigned char * SoTextureImageElement::get (SoState *conststate, SbVec2s &size, int &numComponents, int &wrapS, int &wrapT, int &model, SbColor &blendColor) [static]¶

FIXME: write doc.

const unsigned char * SoTextureImageElement::get (SoState *conststate, SbVec3s &size, int &numComponents, int &wrapS, int &wrapT, int &wrapR, int &model, SbColor &blendColor) [static]¶

FIXME: write doc. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

const unsigned char * SoTextureImageElement::getImage (SoState *conststate, SbVec3s &size, int &numComponents) [static]¶

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

SoTextureImageElement::Wrap SoTextureImageElement::getWrapR ( SoState *conststate) [static]¶

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

const unsigned char * SoTextureImageElement::getDefault (SbVec3s &size, int &numComponents) [static]¶

FIXME: write doc. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

void SoTextureImageElement::setElt (const SbVec3s &sizearg, const intnumComponentsarg, const unsigned char *bytesarg, const WrapwrapSarg, const WrapwrapTarg, const WrapwrapRarg, const Modelmodelarg, const SbColor &blendColorarg) [protected], [virtual]¶

FIXME: write doc. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

SbBool SoTextureImageElement::hasTransparency (void) const [protected], [virtual]¶

Called by containsTransparency(). Returns TRUE if image data has transparency. Default method does a very poor job of detecting this, since it returns TRUE when the number of components are 2 or

4.

Override whenever it is important to know this (SoGLTextureImageElement overrides it to avoid transparency handling where possible).

Reimplemented in SoGLTextureImageElement.

Member Data Documentation¶

SoTextureImageElement::size [protected]¶

FIXME: write doc.

SoTextureImageElement::numComponents [protected]¶

FIXME: write doc.

SoTextureImageElement::bytes [protected]¶

FIXME: write doc.

SoTextureImageElement::wrapS [protected]¶

FIXME: write doc.

SoTextureImageElement::wrapT [protected]¶

FIXME: write doc.

SoTextureImageElement::wrapR [protected]¶

FIXME: write doc. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. Since:

SoTextureImageElement::model [protected]¶

FIXME: write doc.

SoTextureImageElement::blendColor [protected]¶

FIXME: write doc.

Author¶

Generated automatically by Doxygen for Coin from the source code.