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 SoAmbientColorElement Inventor/elements/SoAmbientColorElement.h
35 \brief The SoAmbientColorElement class is yet to be documented.
36
37 \ingroup elements
38 */
39
40
41 #include <Inventor/elements/SoAmbientColorElement.h>
42 #include <Inventor/elements/SoLazyElement.h>
43 #include <Inventor/errors/SoDebugError.h>
44 #include <Inventor/SbColor.h>
45 #include <cassert>
46 #include <cstdlib>
47
48 #include "coindefs.h"
49 #include "SbBasicP.h"
50
51 SO_ELEMENT_SOURCE(SoAmbientColorElement);
52
53 /*!
54 This static method initializes static data for the
55 SoAmbientColorElement class.
56 */
57
58 void
initClass(void)59 SoAmbientColorElement::initClass(void)
60 {
61 SO_ELEMENT_INIT_CLASS(SoAmbientColorElement, inherited);
62 }
63
64 //! FIXME: write doc.
65
66 void
init(SoState * stateptr)67 SoAmbientColorElement::init(SoState * stateptr)
68 {
69 inherited::init(stateptr);
70 this->state = stateptr;
71 }
72
73 /*!
74 The destructor.
75 */
76
~SoAmbientColorElement()77 SoAmbientColorElement::~SoAmbientColorElement()
78 {
79 }
80
81 //! FIXME: write doc.
82
83 void
set(SoState * const state,SoNode * const COIN_UNUSED_ARG (node),const int32_t numcolors,const SbColor * const colors)84 SoAmbientColorElement::set(SoState * const state, SoNode * const COIN_UNUSED_ARG(node),
85 const int32_t numcolors,
86 const SbColor * const colors)
87 {
88 SoLazyElement::setAmbient(state, colors);
89 #if COIN_DEBUG
90 if (numcolors > 1) {
91 SoDebugError::postWarning("SoAmbientColorElement::set",
92 "Multiple ambient colors not supported. "
93 "All color except the first will be ignored.");
94 }
95 #endif // COIN_DEBIG
96 }
97
98 //! FIXME: write doc.
99
100 int32_t
getNum(void) const101 SoAmbientColorElement::getNum(void) const
102 {
103 return 1;
104 }
105
106 //! FIXME: write doc.
107
108 const SbColor &
get(const int index) const109 SoAmbientColorElement::get(const int index) const
110 {
111 assert(index == 0);
112 return SoLazyElement::getAmbient(this->state);
113 }
114
115 /*!
116 Return a pointer to the color array. This method is not part of the OIV API.
117 */
118 const SbColor *
getArrayPtr(void) const119 SoAmbientColorElement::getArrayPtr(void) const
120 {
121 return &SoLazyElement::getAmbient(this->state);
122 }
123
124 //! FIXME: write doc.
125 const SoAmbientColorElement *
getInstance(SoState * state)126 SoAmbientColorElement::getInstance(SoState *state)
127 {
128 return coin_assert_cast<const SoAmbientColorElement *>(
129 state->getElementNoPush(classStackIndex)
130 );
131 }
132