Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
SoAmbientColorElement.h
Go to the documentation of this file.
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2020 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49#ifndef _SO_AMBIENT_COLOR_ELEMENT
50#define _SO_AMBIENT_COLOR_ELEMENT
51
52
53#include <Inventor/SbColor.h>
73
74 public:
75
80 static void set(SoState *state, SoNode *, int32_t numColors, const SbColor *colors);
81
85 static const SoAmbientColorElement * getInstance(SoState *state);
86
90 int32_t getNum() const
91 { return 1; }
92
96 const SbColor& get(int index) const;
97
103
104 private:
105 SoState* saveState;
106};
107
108
109inline void
110#if defined(_DEBUG)
111SoAmbientColorElement::set(SoState *state, SoNode *node, int32_t numColors, const SbColor *colors)
112#else
113SoAmbientColorElement::set(SoState *state, SoNode *node, int32_t, const SbColor *colors)
114#endif
115{
116 SoMaterialElement::setAmbient(state,node,*colors);
117#if defined(_DEBUG)
118 if(numColors>1){
119 SoDebugError::post("SoAmbientColorElement::set",
120 "multiple ambient colors not supported");
121 }
122#endif
123}
124
125
126inline const SoAmbientColorElement *
128{
130 ace->saveState = state;
131 return(ace);
132}
133
134inline const SbColor &
135#if defined(_DEBUG)
136SoAmbientColorElement::get(int index) const
137#else
139#endif
140{
141#if defined(_DEBUG)
142 if(index >1)
143 SoDebugError::post("SoAmbientColorElement::get",
144 "multiple ambient colors not supported");
145#endif
146 return(SoMaterialElement::getAmbient(saveState));
147}
148
149#endif /* _SO_AMBIENT_COLOR_ELEMENT */
150
#define SoEXTENDER_Documented
void set(int32_t numNormals, const SbVec3f *normals, const SoNormalBindingElement::Binding binding, const int startIndex=0)
const SbVec3f & get(int index) const
Color vector class.
Definition SbColor.h:82
Stores ambient color of current material (superseded by SoMaterialElement).
static void set(SoState *state, SoNode *, int32_t numColors, const SbColor *colors)
Sets the current ambient color(s).
int32_t getNum() const
Returns the number of ambient colors in any instance.
static const SoAmbientColorElement * getInstance(SoState *state)
Returns the top (current) instance of the element in the state.
static SbColor getDefault()
Returns the default ambient color.
const SbColor & get(int index) const
Returns the current ambient color.
static void post(const char *methodName, const char *formatString ...)
Posts an error.
static void setAmbient(SoState *state, SoNode *node, const SbColor &color)
static SbColor getDefaultAmbient()
Specify Open Inventor defaults for colors, etc.
Abstract base class for all database nodes.
Definition SoNode.h:145
Traversal state.
Definition SoState.h:74