KiCad PCB EDA Suite
sg_colors.h
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-2017 Cirilo Bernardo <cirilo.bernardo@gmail.com>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
29 #ifndef SG_COLORS_H
30 #define SG_COLORS_H
31 
32 #include <vector>
33 #include "3d_cache/sg/sg_node.h"
34 
35 class SGCOLORS : public SGNODE
36 {
37 public:
38  std::vector< SGCOLOR > colors;
39 
40  void unlinkChildNode( const SGNODE* aNode ) override;
41  void unlinkRefNode( const SGNODE* aNode ) override;
42 
43 public:
44  SGCOLORS( SGNODE* aParent );
45  virtual ~SGCOLORS();
46 
47  virtual bool SetParent( SGNODE* aParent, bool notify = true ) override;
48 
49  SGNODE* FindNode(const char *aNodeName, const SGNODE *aCaller) override;
50  bool AddRefNode( SGNODE* aNode ) override;
51  bool AddChildNode( SGNODE* aNode ) override;
52 
53  bool GetColorList( size_t& aListSize, SGCOLOR*& aColorList );
54  void SetColorList( size_t aListSize, const SGCOLOR* aColorList );
55  void AddColor( double aRedValue, double aGreenValue, double aBlueValue );
56  void AddColor( const SGCOLOR& aColor );
57 
58  void ReNameNodes( void ) override;
59  bool WriteVRML( std::ostream& aFile, bool aReuseFlag ) override;
60 
61  bool WriteCache( std::ostream& aFile, SGNODE* parentNode ) override;
62  bool ReadCache( std::istream& aFile, SGNODE* parentNode ) override;
63 };
64 
65 #endif // SG_COLORS_H
virtual bool SetParent(SGNODE *aParent, bool notify=true) override
Function SetParent sets the parent SGNODE of this object.
Definition: sg_colors.cpp:63
void AddColor(double aRedValue, double aGreenValue, double aBlueValue)
Definition: sg_colors.cpp:186
bool AddChildNode(SGNODE *aNode) override
Definition: sg_colors.cpp:144
bool GetColorList(size_t &aListSize, SGCOLOR *&aColorList)
Definition: sg_colors.cpp:157
bool ReadCache(std::istream &aFile, SGNODE *parentNode) override
Function ReadCache Reads binary format data from a cache file.
Definition: sg_colors.cpp:337
defines the base class of the intermediate scene graph NODE
Class SGNODE represents the base class of all Scene Graph nodes.
Definition: sg_node.h:76
void unlinkChildNode(const SGNODE *aNode) override
Function unlinkChild removes references to an owned child; it is invoked by the child upon destructio...
Definition: sg_colors.cpp:105
bool AddRefNode(SGNODE *aNode) override
Definition: sg_colors.cpp:131
void ReNameNodes(void) override
Function ReNameNodes renames a node and all its child nodes in preparation for Write() operations...
Definition: sg_colors.cpp:200
bool WriteVRML(std::ostream &aFile, bool aReuseFlag) override
Function WriteVRML writes this node's data to a VRML file; this includes all data of child and refere...
Definition: sg_colors.cpp:210
std::vector< SGCOLOR > colors
Definition: sg_colors.h:38
virtual ~SGCOLORS()
Definition: sg_colors.cpp:56
void unlinkRefNode(const SGNODE *aNode) override
Function unlinkRef removes pointers to a referenced node; it is invoked by the referenced node upon d...
Definition: sg_colors.cpp:118
SGNODE * FindNode(const char *aNodeName, const SGNODE *aCaller) override
Function FindNode searches the tree of linked nodes and returns a reference to the first node found w...
Definition: sg_colors.cpp:93
bool WriteCache(std::ostream &aFile, SGNODE *parentNode) override
Function WriteCache write's this node's data to a binary cache file; the data includes all data of ch...
Definition: sg_colors.cpp:268
void SetColorList(size_t aListSize, const SGCOLOR *aColorList)
Definition: sg_colors.cpp:172
SGCOLORS(SGNODE *aParent)
Definition: sg_colors.cpp:31