1 /**************************************************************************\
2 * Copyright (c) Kongsberg Oil & Gas Technologies AS
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 \**************************************************************************/
32
33 /*!
34 \class SoEmissiveColorElement Inventor/elements/SoEmissiveColorElement.h
35 \brief The SoEmissiveColorElement class is yet to be documented.
36
37 \ingroup elements
38
39 FIXME: write doc.
40 */
41
42 #include <Inventor/elements/SoEmissiveColorElement.h>
43 #include <Inventor/elements/SoLazyElement.h>
44 #include <Inventor/errors/SoDebugError.h>
45 #include <Inventor/SbColor.h>
46 #include <cassert>
47 #include <cstdlib>
48
49 #include "coindefs.h"
50 #include "SbBasicP.h"
51
52 SO_ELEMENT_SOURCE(SoEmissiveColorElement);
53
54 /*!
55 This static method initializes static data for the SoEmissiveColorElement
56 class.
57 */
58
59 void
initClass()60 SoEmissiveColorElement::initClass()
61 {
62 SO_ELEMENT_INIT_CLASS(SoEmissiveColorElement, inherited);
63 }
64
65 /*!
66 The destructor.
67 */
68
~SoEmissiveColorElement()69 SoEmissiveColorElement::~SoEmissiveColorElement()
70 {
71 }
72
73 //! FIXME: write doc.
74
75 void
init(SoState * stateptr)76 SoEmissiveColorElement::init(SoState * stateptr)
77 {
78 inherited::init(stateptr);
79 this->state = stateptr;
80 }
81
82 //! FIXME: write doc.
83
84 void
set(SoState * const state,SoNode * const COIN_UNUSED_ARG (node),const int32_t numcolors,const SbColor * const colors)85 SoEmissiveColorElement::set(SoState * const state, SoNode * const COIN_UNUSED_ARG(node),
86 const int32_t numcolors,
87 const SbColor * const colors)
88 {
89 SoLazyElement::setEmissive(state, colors);
90 #if COIN_DEBUG
91 if (numcolors > 1) {
92 SoDebugError::postWarning("SoEmissiveColorElement::set",
93 "Multiple emissive colors not supported. "
94 "All color except the first will be ignored.");
95 }
96 #endif // COIN_DEBIG
97 }
98
99
100 //! FIXME: write doc.
101
102 int32_t
getNum(void) const103 SoEmissiveColorElement::getNum(void) const
104 {
105 return 1;
106 }
107
108 //! FIXME: write doc.
109
110 const SbColor &
get(const int index) const111 SoEmissiveColorElement::get(const int index) const
112 {
113 assert(index == 0);
114 return SoLazyElement::getEmissive(this->state);
115 }
116
117 /*!
118 Returns a pointer to the color array. This method is not part of the OIV API.
119 */
120 const SbColor *
getArrayPtr(void) const121 SoEmissiveColorElement::getArrayPtr(void) const
122 {
123 return & SoLazyElement::getEmissive(this->state);
124 }
125
126 //! FIXME: write doc.
127
128 const SoEmissiveColorElement *
getInstance(SoState * state)129 SoEmissiveColorElement::getInstance(SoState *state)
130 {
131 return coin_assert_cast<const SoEmissiveColorElement *>
132 (
133 state->getElementNoPush(classStackIndex)
134 );
135 }
136