KiCad PCB EDA Suite
ifsg_appearance.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2015 Cirilo Bernardo <[email protected]>
5  * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 
26 #include <iostream>
27 #include <sstream>
28 #include <wx/log.h>
31 
32 
33 extern char BadParent[];
34 extern char WrongParent[];
35 
36 
38 {
39  m_node = nullptr;
40 
41  if( !create )
42  return ;
43 
44  m_node = new SGAPPEARANCE( nullptr );
45 
47 }
48 
49 
51 {
52  m_node = new SGAPPEARANCE( nullptr );
53 
54  if( !m_node->SetParent( aParent ) )
55  {
56  delete m_node;
57  m_node = nullptr;
58 
59  wxLogTrace( MASK_3D_SG, "%s:%s:%d %s", __FILE__, __FUNCTION__, __LINE__, WrongParent );
60 
61  return;
62  }
63 
65 }
66 
67 
69 {
70  SGNODE* pp = aParent.GetRawPtr();
71 
72 #ifdef DEBUG
73  if( ! pp )
74  {
75  wxLogTrace( MASK_3D_SG, "%s:%s:%d %s", __FILE__, __FUNCTION__, __LINE__, BadParent );
76  }
77 #endif
78 
79  m_node = new SGAPPEARANCE( nullptr );
80 
81  if( !m_node->SetParent( pp ) )
82  {
83  delete m_node;
84  m_node = nullptr;
85 
86  wxLogTrace( MASK_3D_SG, "%s:%s:%d %s", __FILE__, __FUNCTION__, __LINE__, WrongParent );
87 
88  return;
89  }
90 
92 }
93 
94 
96 {
97  if( m_node )
99 
100  m_node = nullptr;
101 
102  if( !aNode )
103  return false;
104 
105  if( S3D::SGTYPE_APPEARANCE != aNode->GetNodeType() )
106  {
107  return false;
108  }
109 
110  m_node = aNode;
112 
113  return true;
114 }
115 
116 
118 {
119  if( m_node )
121 
122  m_node = new SGAPPEARANCE( aParent );
123 
124  if( aParent != m_node->GetParent() )
125  {
126  wxLogTrace( MASK_3D_SG, "%s:%s:%d * [BUG] invalid SGNODE parent (%s) to SGAPPEARANCE",
127  __FILE__, __FUNCTION__, __LINE__,
128  aParent->GetNodeTypeName( aParent->GetNodeType() ) );
129 
130  delete m_node;
131  m_node = nullptr;
132  return false;
133  }
134 
136 
137  return true;
138 }
139 
140 
142 {
143  SGNODE* np = aParent.GetRawPtr();
144 
145  wxCHECK( np, false );
146 
147  return NewNode( np );
148 }
149 
150 
151 bool IFSG_APPEARANCE::SetEmissive( float aRVal, float aGVal, float aBVal )
152 {
153  wxCHECK( m_node, false );
154 
155  return ( (SGAPPEARANCE*) m_node )->SetEmissive( aRVal, aGVal, aBVal );
156 }
157 
158 
159 bool IFSG_APPEARANCE::SetEmissive( const SGCOLOR* aRGBColor )
160 {
161  wxCHECK( m_node, false );
162 
163  return ( (SGAPPEARANCE*) m_node )->SetEmissive( aRGBColor );
164 }
165 
166 
167 bool IFSG_APPEARANCE::SetEmissive( const SGCOLOR& aRGBColor )
168 {
169  wxCHECK( m_node, false );
170 
171  return ( (SGAPPEARANCE*) m_node )->SetEmissive( aRGBColor );
172 }
173 
174 
175 bool IFSG_APPEARANCE::SetDiffuse( float aRVal, float aGVal, float aBVal )
176 {
177  wxCHECK( m_node, false );
178 
179  return ( (SGAPPEARANCE*) m_node )->SetDiffuse( aRVal, aGVal, aBVal );
180 }
181 
182 
183 bool IFSG_APPEARANCE::SetDiffuse( const SGCOLOR* aRGBColor )
184 {
185  wxCHECK( m_node, false );
186 
187  return ( (SGAPPEARANCE*) m_node )->SetDiffuse( aRGBColor );
188 }
189 
190 
191 bool IFSG_APPEARANCE::SetDiffuse( const SGCOLOR& aRGBColor )
192 {
193  wxCHECK( m_node, false );
194 
195  return ( (SGAPPEARANCE*) m_node )->SetDiffuse( aRGBColor );
196 }
197 
198 
199 bool IFSG_APPEARANCE::SetSpecular( float aRVal, float aGVal, float aBVal )
200 {
201  wxCHECK( m_node, false );
202 
203  return ( (SGAPPEARANCE*) m_node )->SetSpecular( aRVal, aGVal, aBVal );
204 }
205 
206 
207 bool IFSG_APPEARANCE::SetSpecular( const SGCOLOR* aRGBColor )
208 {
209  wxCHECK( m_node, false );
210 
211  return ( (SGAPPEARANCE*) m_node )->SetSpecular( aRGBColor );
212 }
213 
214 
215 bool IFSG_APPEARANCE::SetSpecular( const SGCOLOR& aRGBColor )
216 {
217  wxCHECK( m_node, false );
218 
219  return ( (SGAPPEARANCE*) m_node )->SetSpecular( aRGBColor );
220 }
221 
222 
223 bool IFSG_APPEARANCE::SetAmbient( float aRVal, float aGVal, float aBVal )
224 {
225  wxCHECK( m_node, false );
226 
227  return ( (SGAPPEARANCE*) m_node )->SetAmbient( aRVal, aGVal, aBVal );
228 }
229 
230 
231 bool IFSG_APPEARANCE::SetAmbient( const SGCOLOR* aRGBColor )
232 {
233  wxCHECK( m_node, false );
234 
235  return ( (SGAPPEARANCE*) m_node )->SetAmbient( aRGBColor );
236 }
237 
238 
239 bool IFSG_APPEARANCE::SetAmbient( const SGCOLOR& aRGBColor )
240 {
241  wxCHECK( m_node, false );
242 
243  return ( (SGAPPEARANCE*) m_node )->SetAmbient( aRGBColor );
244 }
245 
246 
247 bool IFSG_APPEARANCE::SetShininess( float aShininess ) noexcept
248 {
249  wxCHECK( m_node, false );
250 
251  if( aShininess < 0 || aShininess > 1.0 )
252  {
253  wxLogTrace( MASK_3D_SG, "%s:%s:%d * [BUG] shininess out of range [0..1]",
254  __FILE__, __FUNCTION__, __LINE__ );
255 
256  return false;
257  }
258 
259  ( (SGAPPEARANCE*) m_node )->shininess = aShininess;
260 
261  return true;
262 }
263 
264 
265 bool IFSG_APPEARANCE::SetTransparency( float aTransparency ) noexcept
266 {
267  wxCHECK( m_node, false );
268 
269  if( aTransparency < 0 || aTransparency > 1.0 )
270  {
271  wxLogTrace( MASK_3D_SG, "%s:%s:%d * [BUG] transparency out of range [0..1]",
272  __FILE__, __FUNCTION__, __LINE__ );
273 
274  return false;
275  }
276 
277  ( (SGAPPEARANCE*) m_node )->transparency = aTransparency;
278 
279  return true;
280 }
bool SetTransparency(float aTransparency) noexcept
char WrongParent[]
Definition: ifsg_node.cpp:39
bool SetDiffuse(float aRVal, float aGVal, float aBVal)
IFSG_APPEARANCE(bool create)
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:205
SGNODE * m_node
Definition: ifsg_node.h:57
IFSG_NODE represents the base class of all DLL-safe Scene Graph nodes.
Definition: ifsg_node.h:54
The base class of all Scene Graph nodes.
Definition: sg_node.h:74
SGNODE * GetRawPtr(void) noexcept
Function GetRawPtr() returns the raw internal SGNODE pointer.
Definition: ifsg_node.cpp:65
bool Attach(SGNODE *aNode) override
Function Attach associates a given SGNODE* with this wrapper.
bool SetAmbient(float aRVal, float aGVal, float aBVal)
void DisassociateWrapper(SGNODE **aWrapperRef) noexcept
Remove the association between an IFSG* wrapper object and this object.
Definition: sg_node.cpp:223
const char * GetNodeTypeName(S3D::SGTYPES aNodeType) const noexcept
Definition: sg_node.cpp:164
char BadParent[]
Definition: ifsg_node.cpp:38
bool SetShininess(float aShininess) noexcept
SGNODE * GetParent(void) const noexcept
Returns a pointer to the parent SGNODE of this object or NULL if the object has no parent (ie.
Definition: sg_node.cpp:110
bool SetEmissive(float aRVal, float aGVal, float aBVal)
bool SetSpecular(float aRVal, float aGVal, float aBVal)
virtual bool SetParent(SGNODE *aParent, bool notify=true)=0
Set the parent SGNODE of this object.
defines the wrapper of the SGAPPEARANCE class
Defines the generic material appearance of a scenegraph object.
Definition: sg_appearance.h:37
S3D::SGTYPES GetNodeType(void) const noexcept
Return the type of this node instance.
Definition: sg_node.cpp:104
bool NewNode(SGNODE *aParent) override
Function NewNode creates a new node to associate with this wrapper.