SoTextureCoordinateBundle(3) Coin SoTextureCoordinateBundle(3)NAME
SoTextureCoordinateBundle -
The SoTextureCoordinateBundle class simplifies texture coordinate handling.
It is unlikely that application programmers should need to know how to use this class, as it is mostly intended for internal use.
SYNOPSIS
#include <include/Inventor/bundles/SoTextureCoordinateBundle.h>
Inherits SoBundle.
Public Member Functions
SoTextureCoordinateBundle (SoAction *const action, const SbBool forRendering, const SbBool setUpDefault=TRUE)
~SoTextureCoordinateBundle ()
SbBool needCoordinates (void) const
SbBool isFunction (void) const
const SbVec4f & get (const int index)
const SbVec4f & get (const SbVec3f &point, const SbVec3f &normal)
void send (const int index) const
void send (const int index, const SbVec3f &point, const SbVec3f &normal) const
SbBool needIndices (void) const
Additional Inherited Members
Detailed Description
The SoTextureCoordinateBundle class simplifies texture coordinate handling.
It is unlikely that application programmers should need to know how to use this class, as it is mostly intended for internal use.
Constructor &; Destructor Documentation
SoTextureCoordinateBundle::SoTextureCoordinateBundle (SoAction *constaction, const SbBoolforRendering, const SbBoolsetUpDefault = TRUE)
Constructor with action being the action applied to the node. The forRendering parameter must be TRUE if the bundle is to be used for
sending texture coordinates to GL during rendering. The setUpDefault must be TRUE if default texture coordinates should be generated.
SoTextureCoordinateBundle::~SoTextureCoordinateBundle ()
Destructor.
Member Function Documentation
SbBool SoTextureCoordinateBundle::needCoordinates (void) const
Returns TRUE if texture coordinates is needed during rendering.
SbBool SoTextureCoordinateBundle::isFunction (void) const
Returns TRUE if a texture coordinate function should be used.
const SbVec4f & SoTextureCoordinateBundle::get (const intindex)
Returns the texture coordinates at index index. Should only be used if SoTextureCoordinateBundle::isFunction() is FALSE.
const SbVec4f & SoTextureCoordinateBundle::get (const SbVec3f &point, const SbVec3f &normal)
Returns the texture coordinates based on point and normal. Should only be used if SoTextureCoordinateBundle::isFunction() is TRUE.
void SoTextureCoordinateBundle::send (const intindex) const [inline]
Send texture coordinates to GL. Should only be used if SoTextureCoordinateBundle::isFunction() is FALSE.
void SoTextureCoordinateBundle::send (const intindex, const SbVec3f &point, const SbVec3f &normal) const [inline]
Convenience function that will make it transparent to the rendering code if ordinary texture coordinates or function texture coordinates
are used.
SbBool SoTextureCoordinateBundle::needIndices (void) const
Returns TRUE if isFunction() is TRUE, but the texture coordinate indices are needed either by bump mapping or by one of the other texture
units.
Since:
Coin 2.2
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SoTextureCoordinateBundle(3)
Check Out this Related Man Page
SoTextureCoordinateElement(3) Coin SoTextureCoordinateElement(3)NAME
SoTextureCoordinateElement -
The SoTextureCoordinateElement class is yet to be documented.
FIXME: write doc.
SYNOPSIS
#include <Inventor/elements/SoTextureCoordinateElement.h>
Inherits SoReplacedElement.
Inherited by SoGLTextureCoordinateElement.
Public Types
enum CoordType { NONE = 0, TEXGEN = 0, EXPLICIT = 1, FUNCTION = 2, DEFAULT = 3 }
Public Member Functions
virtual void init (SoState *state)
FIXME: write doc.
virtual CoordType getType (void) const
FIXME: write doc.
const SbVec4f & get (const SbVec3f &point, const SbVec3f &normal) const
int32_t getNum (void) const
FIXME: write doc.
SbBool is2D (void) const
FIXME: write doc. (for backwards compability. Use getDimension() instead).
int32_t getDimension (void) const
const SbVec2f & get2 (const int index) const
FIXME: write doc.
const SbVec3f & get3 (const int index) const
const SbVec4f & get4 (const int index) const
FIXME: write doc.
const SbVec2f * getArrayPtr2 (void) const
const SbVec3f * getArrayPtr3 (void) const
const SbVec4f * getArrayPtr4 (void) 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)
FIXME: write doc.
static void setFunction (SoState *const state, SoNode *const node, SoTextureCoordinateFunctionCB *const func, void *const userdata)
FIXME: write doc.
static void set2 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec2f *const coords)
FIXME: write doc.
static void set3 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec3f *const coords)
static void set4 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec4f *const coords)
FIXME: write doc.
static CoordType getType (SoState *const state)
static const
SoTextureCoordinateElement * getInstance (SoState *const state)"
FIXME: write doc.
Protected Member Functions
virtual ~SoTextureCoordinateElement ()
Protected Attributes
CoordType whatKind
SoTextureCoordinateFunctionCB * funcCB
void * funcCBData
int32_t numCoords
const SbVec2f * coords2
const SbVec3f * coords3
const SbVec4f * coords4
SbBool coordsDimension
SbVec2f convert2
SbVec3f convert3
SbVec4f convert4
Additional Inherited Members
Detailed Description
The SoTextureCoordinateElement 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
Member Enumeration Documentation
enum SoTextureCoordinateElement::CoordType
FIXME: write doc.
Constructor &; Destructor Documentation
SoTextureCoordinateElement::~SoTextureCoordinateElement () [protected], [virtual]
The destructor.
Member Function Documentation
SoType SoTextureCoordinateElement::getClassTypeId (void) [static]
This static method returns the class type.
Reimplemented from SoReplacedElement.
Reimplemented in SoGLTextureCoordinateElement.
int SoTextureCoordinateElement::getClassStackIndex (void) [static]
This static method returns the state stack index for the class.
Reimplemented from SoReplacedElement.
Reimplemented in SoGLTextureCoordinateElement.
void * SoTextureCoordinateElement::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 SoGLTextureCoordinateElement.
void SoTextureCoordinateElement::initClass (void) [static]
This static method initializes static data for the SoTextureCoordinateElement class.
Reimplemented from SoReplacedElement.
Reimplemented in SoGLTextureCoordinateElement.
void SoTextureCoordinateElement::set3 (SoState *conststate, SoNode *constnode, const int32_tnumCoords, const SbVec3f *constcoords) [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:
Coin 2.0
SoTextureCoordinateElement::CoordType SoTextureCoordinateElement::getType (SoState *conststate) [static]
This method is used by shapes. Three return values are possible.
DEFAULT means that the shapes should generate their own texture coordinates.
EXPLICIT means that discrete texture coordinates are stored, and should be fetched with get2(), get3() or get4().
FUNCTION means that get(point, normal) must be used to generate texture coordinates.
const SbVec4f & SoTextureCoordinateElement::get (const SbVec3f &point, const SbVec3f &normal) const
This method returns texture coordinate for the given point and normal. The coordinate is returned as a 4D vector where the r and q
coordinates may be set to 0 and 1 respecively depending on what texture coordinate dimension we're using.
This method should only be used if the CoordType is FUNCTION.
int32_t SoTextureCoordinateElement::getDimension (void) const
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:
Coin 2.0
const SbVec3f & SoTextureCoordinateElement::get3 (const intindex) const
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:
Coin 2.0
const SbVec2f * SoTextureCoordinateElement::getArrayPtr2 (void) const
Returns a pointer to the 2D texture coordinate array. This method is not part of the OIV API.
const SbVec3f * SoTextureCoordinateElement::getArrayPtr3 (void) const
Returns a pointer to the 3D texture coordinate array.
This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
Since:
Coin 2.0
const SbVec4f * SoTextureCoordinateElement::getArrayPtr4 (void) const
Returns a pointer to the 4D texture coordinate array. This method is not part of the OIV API.
Member Data Documentation
SoTextureCoordinateElement::whatKind [protected]
FIXME: write doc.
SoTextureCoordinateElement::funcCB [protected]
FIXME: write doc.
SoTextureCoordinateElement::funcCBData [protected]
FIXME: write doc.
SoTextureCoordinateElement::numCoords [protected]
FIXME: write doc.
SoTextureCoordinateElement::coords2 [protected]
FIXME: write doc.
SoTextureCoordinateElement::coords3 [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:
Coin 2.0
SoTextureCoordinateElement::coords4 [protected]
FIXME: write doc.
SoTextureCoordinateElement::coordsDimension [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:
Coin 2.0
SoTextureCoordinateElement::convert2 [protected]
FIXME: write doc.
SoTextureCoordinateElement::convert3 [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:
Coin 2.0
SoTextureCoordinateElement::convert4 [protected]
FIXME: write doc.
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SoTextureCoordinateElement(3)