Coin Logo http://www.sim.no/
http://www.coin3d.org/

SoMultiTextureImageElement Class Reference
[Element Classes]

The SoMultiTextureImageElement class is yet to be documented.

FIXME: write doc. More...

#include <Inventor/elements/SoMultiTextureImageElement.h>

Inheritance diagram for SoMultiTextureImageElement:

SoElement SoGLMultiTextureImageElement

List of all members.

Public Member Functions

virtual void init (SoState *state)
 FIXME: write doc.
virtual void push (SoState *state)
virtual SbBool matches (const SoElement *elem) const
SoElementcopyMatchInfo (void) const
virtual void setElt (const int unit, const uint32_t nodeid, const SbVec2s &size, const int numComponents, const unsigned char *bytes, const SoTextureImageElement::Wrap wrapS, const SoTextureImageElement::Wrap wrapT, const SoTextureImageElement::Model model, const SbColor &blendColor)
 FIXME: write doc.
virtual void setElt (const int unit, const uint32_t nodeid, const SbVec3s &size, const int numComponents, const unsigned char *bytes, const SoTextureImageElement::Wrap wrapS, const SoTextureImageElement::Wrap wrapT, const SoTextureImageElement::Wrap wrapR, const SoTextureImageElement::Model model, const SbColor &blendColor)
virtual SbBool hasTransparency (const int unit) const

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, const int unit)
static void set (SoState *const state, SoNode *const node, const int unit, const SbVec2s &size, const int numComponents, const unsigned char *bytes, const SoTextureImageElement::Wrap wrapS, const SoTextureImageElement::Wrap wrapT, const SoTextureImageElement::Model model, const SbColor &blendColor)
 FIXME: write doc.
static void set (SoState *const state, SoNode *const node, const int unit, const SbVec3s &size, const int numComponents, const unsigned char *bytes, const SoTextureImageElement::Wrap wrapS, const SoTextureImageElement::Wrap wrapT, const SoTextureImageElement::Wrap wrapR, const SoTextureImageElement::Model model, const SbColor &blendColor)
static const unsigned char * get (SoState *const state, const int unit, SbVec2s &size, int &numComponents, SoTextureImageElement::Wrap &wrapS, SoTextureImageElement::Wrap &wrapT, SoTextureImageElement::Model &model, SbColor &blendColor)
 FIXME: write doc.
static const unsigned char * get (SoState *const state, const int unit, SbVec3s &size, int &numComponents, SoTextureImageElement::Wrap &wrapS, SoTextureImageElement::Wrap &wrapT, SoTextureImageElement::Wrap &wrapR, SoTextureImageElement::Model &model, SbColor &blendColor)
static const unsigned char * getImage (SoState *const state, const int unit, SbVec2s &size, int &numComponents)
static const unsigned char * getImage (SoState *const state, const int unit, SbVec3s &size, int &numComponents)
static const SbColorgetBlendColor (SoState *const state, const int unit)
static SoTextureImageElement::Model getModel (SoState *const state, const int unit)
static SoTextureImageElement::Wrap getWrapS (SoState *const state, const int unit)
static SoTextureImageElement::Wrap getWrapT (SoState *const state, const int unit)
static SoTextureImageElement::Wrap getWrapR (SoState *const state, const int unit)
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 ~SoMultiTextureImageElement ()
const UnitData & getUnitData (const int unit) const


Detailed Description

The SoMultiTextureImageElement class is yet to be documented.

FIXME: write doc.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:
Coin 2.2

Constructor & Destructor Documentation

SoMultiTextureImageElement::~SoMultiTextureImageElement (  )  [protected, virtual]

The destructor.


Member Function Documentation

SoType SoMultiTextureImageElement::getClassTypeId ( void   )  [static]

This static method returns the class type.

Reimplemented from SoElement.

Reimplemented in SoGLMultiTextureImageElement.

int SoMultiTextureImageElement::getClassStackIndex ( void   )  [static]

This static method returns the state stack index for the class.

Reimplemented from SoElement.

Reimplemented in SoGLMultiTextureImageElement.

void * SoMultiTextureImageElement::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 SoGLMultiTextureImageElement.

void SoMultiTextureImageElement::initClass ( void   )  [static]

This static method initializes static data for the SoMultiTextureImageElement class.

Reimplemented from SoElement.

Reimplemented in SoGLMultiTextureImageElement.

void SoMultiTextureImageElement::set ( SoState *const   state,
SoNode *const   node,
const int  unit,
const SbVec3s size,
const int  numComponents,
const unsigned char *  bytes,
const SoTextureImageElement::Wrap  wrapS,
const SoTextureImageElement::Wrap  wrapT,
const SoTextureImageElement::Wrap  wrapR,
const SoTextureImageElement::Model  model,
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.

const unsigned char * SoMultiTextureImageElement::get ( SoState *const   state,
const int  unit,
SbVec3s size,
int &  numComponents,
SoTextureImageElement::Wrap wrapS,
SoTextureImageElement::Wrap wrapT,
SoTextureImageElement::Wrap wrapR,
SoTextureImageElement::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.

const unsigned char * SoMultiTextureImageElement::getImage ( SoState *const   state,
const int  unit,
SbVec2s size,
int &  numComponents 
) [static]

FIXME: write doc

const unsigned char * SoMultiTextureImageElement::getImage ( SoState *const   state,
const int  unit,
SbVec3s size,
int &  numComponents 
) [static]

FIXME: write doc

const SbColor & SoMultiTextureImageElement::getBlendColor ( SoState *const   state,
const int  unit 
) [static]

FIXME: write doc.

SoTextureImageElement::Model SoMultiTextureImageElement::getModel ( SoState *const   state,
const int  unit 
) [static]

FIXME: write doc.

SoTextureImageElement::Wrap SoMultiTextureImageElement::getWrapS ( SoState *const   state,
const int  unit 
) [static]

FIXME: write doc.

SoTextureImageElement::Wrap SoMultiTextureImageElement::getWrapT ( SoState *const   state,
const int  unit 
) [static]

FIXME: write doc.

SoTextureImageElement::Wrap SoMultiTextureImageElement::getWrapR ( SoState *const   state,
const int  unit 
) [static]

FIXME: write doc.

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

FIXME: write doc.

SoElement * SoMultiTextureImageElement::copyMatchInfo ( void   )  const [virtual]

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scenegraph traversal caching operations.

Implements SoElement.

void SoMultiTextureImageElement::setElt ( const int  unit,
const uint32_t  nodeid,
const SbVec3s size,
const int  numComponents,
const unsigned char *  bytes,
const SoTextureImageElement::Wrap  wrapS,
const SoTextureImageElement::Wrap  wrapT,
const SoTextureImageElement::Wrap  wrapR,
const SoTextureImageElement::Model  model,
const SbColor blendColor 
) [virtual]

FIXME: write doc.

SbBool SoMultiTextureImageElement::hasTransparency ( const int  unit  )  const [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 SoGLMultiTextureImageElement.


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

Copyright © 1998-2009 by Kongsberg SIM. All rights reserved.

Generated on Mon Jun 15 11:58:39 2009 for Coin by Doxygen 1.5.9.