other versions
- jessie 3.1.4~abc9f50-7
SoOverrideElement(3) | Coin | SoOverrideElement(3) |
NAME¶
SoOverrideElement - The SoOverrideElement maintains a list of overridable elements and a list over which elements should be overridden. Only certain elements can be overridden.SYNOPSIS¶
#include <Inventor/elements/SoOverrideElement.h> Inherits SoElement.Public Types¶
enum FlagBits { AMBIENT_COLOR = 0x00000001, COLOR_INDEX = 0x00000002, COMPLEXITY = 0x00000004, COMPLEXITY_TYPE = 0x00000008, CREASE_ANGLE = 0x00000010, DIFFUSE_COLOR = 0x00000020, DRAW_STYLE = 0x00000040, EMISSIVE_COLOR = 0x00000080, FONT_NAME = 0x00000100, FONT_SIZE = 0x00000200, LIGHT_MODEL = 0x00000400, LINE_PATTERN = 0x00000800, LINE_WIDTH = 0x00001000, MATERIAL_BINDING = 0x00002000, POINT_SIZE = 0x00004000, PICK_STYLE = 0x00008000, SHAPE_HINTS = 0x00010000, SHININESS = 0x00020000, SPECULAR_COLOR = 0x00040000, POLYGON_OFFSET = 0x00080000, TRANSPARENCY = 0x00100000, TRANSPARENCY_TYPE = 0x00200000, NORMAL_VECTOR = 0x00400000, NORMAL_BINDING = 0x00800000 }
Public Member Functions¶
virtual void init (SoState *state)
Static Public Member Functions¶
static SoType getClassTypeId (void)
Protected Member Functions¶
virtual ~SoOverrideElement ()
Additional Inherited Members¶
Detailed Description¶
The SoOverrideElement maintains a list of overridable elements and a list over which elements should be overridden. Only certain elements can be overridden. The remaining class documentation describes a single, special case: A common request for functionality is to override only the transparency of the full scene graph, or parts of the scene graph. In the original SGI Inventor, this is nigh impossible, as the API was designed to only make it possible to override all or none of the fields of a node. So calling SoNode::setOverride() on an SoMaterial node will cause all material settings of that node to override all material settings further on in the scene graph, and there is no way to override only the transparency settings. In Coin, we have added in a little hack to overcome this problem, since it is such a common request for functionality: to have separate transparency override settings, set the environment variable COIN_SEPARATE_DIFFUSE_TRANSPARENCY_OVERRIDE to '1' to enable this hack. (Do however note that this will not work when the SoPackedColor or SoVertexProperty node is used to specify diffuse color and transparency -- only with the SoMaterial node.) Here is a complete, stand-alone example which demonstrates how to accomplish this:#include <Inventor/Qt/SoQt.h> #include <Inventor/Qt/viewers/SoQtExaminerViewer.h> #include <Inventor/nodes/SoSeparator.h> #include <Inventor/nodes/SoMaterial.h> // ************************************************************************* const char * scene = "#Inventor V2.1 asci0 "0 "Separator {" " Cone { }" " Translation { translation 1 0 5 }" "" " DEF OVERRIDEMATERIAL Material { transparency 0.5 }" "" " DEF OBJMATERIAL Material {" " diffuseColor 0.5 0 0" " transparency 0" " }" " Sphere { }" "}" ; int main(int argc, char ** argv) { QWidget * window = SoQt::init(argv[0]); (void)coin_setenv("COIN_SEPARATE_DIFFUSE_TRANSPARENCY_OVERRIDE", "1", TRUE); SoInput * in = new SoInput; in->setBuffer((void *)scene, strlen(scene)); SoSeparator * root = SoDB::readAll(in); assert(root); delete in; root->ref(); SoMaterial * overridemat = (SoMaterial *) SoBase::getNamedBase("OVERRIDEMATERIAL", SoMaterial::getClassTypeId()); assert(overridemat); overridemat->diffuseColor.setIgnored(TRUE); overridemat->setOverride(TRUE); SoQtExaminerViewer * viewer = new SoQtExaminerViewer(window); viewer->setSceneGraph(root); viewer->show(); SoQt::show(window); SoQt::mainLoop(); delete viewer; root->unref(); return 0; }
Member Enumeration Documentation¶
enum SoOverrideElement::FlagBits¶
FIXME: write doc.Constructor & Destructor Documentation¶
SoOverrideElement::~SoOverrideElement (void) [protected], [virtual]¶
The destructor.Member Function Documentation¶
void * SoOverrideElement::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.void SoOverrideElement::initClass (void) [static]¶
This static method initializes static data for the SoOverrideElement class.SbBool SoOverrideElement::getAmbientColorOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getColorIndexOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getComplexityOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getComplexityTypeOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getCreaseAngleOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getDiffuseColorOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getDrawStyleOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getEmissiveColorOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getFontNameOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getFontSizeOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getLightModelOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getLinePatternOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getLineWidthOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getMaterialBindingOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getPickStyleOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getPointSizeOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getPolygonOffsetOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getShapeHintsOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getShininessOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getSpecularColorOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getTransparencyOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getTransparencyTypeOverride ( SoState *conststate) [static]¶
FIXME: write doc.SbBool SoOverrideElement::getNormalVectorOverride ( SoState *conststate) [static]¶
Returns normal vector override value. Since:Coin 2.0
SbBool SoOverrideElement::getNormalBindingOverride ( SoState *conststate) [static]¶
Returns normal binding override value. Since:Coin 2.0
void SoOverrideElement::setAmbientColorOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setColorIndexOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setComplexityOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setComplexityTypeOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setCreaseAngleOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setDiffuseColorOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
Can be used to set diffuse color override. This will also set the transparency override. Since we feel this is a design flaw, it is possible to override this behaviour by setting an environement value called COIN_SEPARATE_DIFFUSE_TRANSPARENCY_OVERRIDE to 1. Please note that separate override will not work for the PackedColor or SoVertexProperty nodes.void SoOverrideElement::setDrawStyleOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setEmissiveColorOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setFontNameOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setFontSizeOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setLightModelOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setLinePatternOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setLineWidthOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setPickStyleOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setPointSizeOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setPolygonOffsetOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setShapeHintsOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setShininessOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setSpecularColorOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
FIXME: write doc.void SoOverrideElement::setTransparencyOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
Can be used to set the transparency override. See also:setDiffuseColorOverride().
void SoOverrideElement::setTransparencyTypeOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
Can be used to set the transparency type override. See also:setDiffuseColorOverride().
void SoOverrideElement::setNormalVectorOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
Can be used to set normal vector override. Since:Coin 2.0
void SoOverrideElement::setNormalBindingOverride ( SoState *conststate, SoNode *constnode, const SbBooloverride) [static]¶
Can be used to set normal binding override. Since:Coin 2.0
Author¶
Generated automatically by Doxygen for Coin from the source code.Thu May 29 2014 | Version 4.0.0a |