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
33extern char BadParent[];
34extern 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, wxT( "%s:%s:%d %s" ), __FILE__, __FUNCTION__, __LINE__,
61
62 return;
63 }
64
66}
67
68
70{
71 SGNODE* pp = aParent.GetRawPtr();
72
73#ifdef DEBUG
74 if( ! pp )
75 {
76 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d %s" ), __FILE__, __FUNCTION__, __LINE__,
77 BadParent );
78 }
79#endif
80
81 m_node = new SGAPPEARANCE( nullptr );
82
83 if( !m_node->SetParent( pp ) )
84 {
85 delete m_node;
86 m_node = nullptr;
87
88 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d %s" ), __FILE__, __FUNCTION__, __LINE__,
90
91 return;
92 }
93
95}
96
97
99{
100 if( m_node )
102
103 m_node = nullptr;
104
105 if( !aNode )
106 return false;
107
108 if( S3D::SGTYPE_APPEARANCE != aNode->GetNodeType() )
109 {
110 return false;
111 }
112
113 m_node = aNode;
115
116 return true;
117}
118
119
121{
122 if( m_node )
124
125 m_node = new SGAPPEARANCE( aParent );
126
127 if( aParent != m_node->GetParent() )
128 {
129 wxLogTrace( MASK_3D_SG,
130 wxT( "%s:%s:%d * [BUG] invalid SGNODE parent (%s) to SGAPPEARANCE" ),
131 __FILE__, __FUNCTION__, __LINE__,
132 aParent->GetNodeTypeName( aParent->GetNodeType() ) );
133
134 delete m_node;
135 m_node = nullptr;
136 return false;
137 }
138
140
141 return true;
142}
143
144
146{
147 SGNODE* np = aParent.GetRawPtr();
148
149 wxCHECK( np, false );
150
151 return NewNode( np );
152}
153
154
155bool IFSG_APPEARANCE::SetEmissive( float aRVal, float aGVal, float aBVal )
156{
157 wxCHECK( m_node, false );
158
159 return ( (SGAPPEARANCE*) m_node )->SetEmissive( aRVal, aGVal, aBVal );
160}
161
162
163bool IFSG_APPEARANCE::SetEmissive( const SGCOLOR* aRGBColor )
164{
165 wxCHECK( m_node, false );
166
167 return ( (SGAPPEARANCE*) m_node )->SetEmissive( aRGBColor );
168}
169
170
171bool IFSG_APPEARANCE::SetEmissive( const SGCOLOR& aRGBColor )
172{
173 wxCHECK( m_node, false );
174
175 return ( (SGAPPEARANCE*) m_node )->SetEmissive( aRGBColor );
176}
177
178
179bool IFSG_APPEARANCE::SetDiffuse( float aRVal, float aGVal, float aBVal )
180{
181 wxCHECK( m_node, false );
182
183 return ( (SGAPPEARANCE*) m_node )->SetDiffuse( aRVal, aGVal, aBVal );
184}
185
186
187bool IFSG_APPEARANCE::SetDiffuse( const SGCOLOR* aRGBColor )
188{
189 wxCHECK( m_node, false );
190
191 return ( (SGAPPEARANCE*) m_node )->SetDiffuse( aRGBColor );
192}
193
194
195bool IFSG_APPEARANCE::SetDiffuse( const SGCOLOR& aRGBColor )
196{
197 wxCHECK( m_node, false );
198
199 return ( (SGAPPEARANCE*) m_node )->SetDiffuse( aRGBColor );
200}
201
202
203bool IFSG_APPEARANCE::SetSpecular( float aRVal, float aGVal, float aBVal )
204{
205 wxCHECK( m_node, false );
206
207 return ( (SGAPPEARANCE*) m_node )->SetSpecular( aRVal, aGVal, aBVal );
208}
209
210
211bool IFSG_APPEARANCE::SetSpecular( const SGCOLOR* aRGBColor )
212{
213 wxCHECK( m_node, false );
214
215 return ( (SGAPPEARANCE*) m_node )->SetSpecular( aRGBColor );
216}
217
218
219bool IFSG_APPEARANCE::SetSpecular( const SGCOLOR& aRGBColor )
220{
221 wxCHECK( m_node, false );
222
223 return ( (SGAPPEARANCE*) m_node )->SetSpecular( aRGBColor );
224}
225
226
227bool IFSG_APPEARANCE::SetAmbient( float aRVal, float aGVal, float aBVal )
228{
229 wxCHECK( m_node, false );
230
231 return ( (SGAPPEARANCE*) m_node )->SetAmbient( aRVal, aGVal, aBVal );
232}
233
234
235bool IFSG_APPEARANCE::SetAmbient( const SGCOLOR* aRGBColor )
236{
237 wxCHECK( m_node, false );
238
239 return ( (SGAPPEARANCE*) m_node )->SetAmbient( aRGBColor );
240}
241
242
243bool IFSG_APPEARANCE::SetAmbient( const SGCOLOR& aRGBColor )
244{
245 wxCHECK( m_node, false );
246
247 return ( (SGAPPEARANCE*) m_node )->SetAmbient( aRGBColor );
248}
249
250
251bool IFSG_APPEARANCE::SetShininess( float aShininess ) noexcept
252{
253 wxCHECK( m_node, false );
254
255 if( aShininess < 0 || aShininess > 1.0 )
256 {
257 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] shininess out of range [0..1]" ),
258 __FILE__, __FUNCTION__, __LINE__ );
259
260 return false;
261 }
262
263 ( (SGAPPEARANCE*) m_node )->shininess = aShininess;
264
265 return true;
266}
267
268
269bool IFSG_APPEARANCE::SetTransparency( float aTransparency ) noexcept
270{
271 wxCHECK( m_node, false );
272
273 if( aTransparency < 0 || aTransparency > 1.0 )
274 {
275 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] transparency out of range [0..1]" ),
276 __FILE__, __FUNCTION__, __LINE__ );
277
278 return false;
279 }
280
281 ( (SGAPPEARANCE*) m_node )->transparency = aTransparency;
282
283 return true;
284}
bool SetDiffuse(float aRVal, float aGVal, float aBVal)
bool SetEmissive(float aRVal, float aGVal, float aBVal)
bool Attach(SGNODE *aNode) override
Function Attach associates a given SGNODE* with this wrapper.
bool SetSpecular(float aRVal, float aGVal, float aBVal)
bool SetShininess(float aShininess) noexcept
bool NewNode(SGNODE *aParent) override
Function NewNode creates a new node to associate with this wrapper.
bool SetAmbient(float aRVal, float aGVal, float aBVal)
IFSG_APPEARANCE(bool create)
bool SetTransparency(float aTransparency) noexcept
IFSG_NODE represents the base class of all DLL-safe Scene Graph nodes.
Definition: ifsg_node.h:55
SGNODE * GetRawPtr(void) noexcept
Function GetRawPtr() returns the raw internal SGNODE pointer.
Definition: ifsg_node.cpp:65
SGNODE * m_node
Definition: ifsg_node.h:57
Defines the generic material appearance of a scenegraph object.
Definition: sg_appearance.h:38
The base class of all Scene Graph nodes.
Definition: sg_node.h:75
virtual bool SetParent(SGNODE *aParent, bool notify=true)=0
Set the parent SGNODE of this object.
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
S3D::SGTYPES GetNodeType(void) const noexcept
Return the type of this node instance.
Definition: sg_node.cpp:104
void AssociateWrapper(SGNODE **aWrapperRef) noexcept
Associate this object with a handle to itself.
Definition: sg_node.cpp:207
const char * GetNodeTypeName(S3D::SGTYPES aNodeType) const noexcept
Definition: sg_node.cpp:164
void DisassociateWrapper(SGNODE **aWrapperRef) noexcept
Remove the association between an IFSG* wrapper object and this object.
Definition: sg_node.cpp:225
char BadParent[]
Definition: ifsg_node.cpp:38
char WrongParent[]
Definition: ifsg_node.cpp:39
defines the wrapper of the SGAPPEARANCE class
@ SGTYPE_APPEARANCE
Definition: sg_types.h:37