Actin®  Version 5.2.0
Software for Robotics Simulation and Control
ecLightParameters.h
Go to the documentation of this file.
1 #ifndef ecLightParameters_H_
2 #define ecLightParameters_H_
3 //------------------------------------------------------------------------------
4 // Copyright (c) 2002-2013 Energid Technologies. All rights reserved.
5 //
9 //
10 //------------------------------------------------------------------------------
11 #include <foundation/foundation_config.h> // Required to be first header.
12 #include "ecLight.h"
13 #include <xml/ecXmlCompType.h>
14 
17 {
18 public:
21  (
22  );
23 
25  virtual ~EcLightParameters
26  (
27  );
28 
31  (
32  const EcLightParameters& orig
33  );
34 
36  EcLightParameters& operator=
37  (
38  const EcLightParameters& orig
39  );
40 
42  EcBoolean operator==
43  (
44  const EcLightParameters& orig
45  ) const;
46 
48  virtual EcBoolean xmlInit
49  (
50  ) EC_OVERRIDE;
51 
53  virtual EcXmlObject* clone
54  (
55  ) const EC_OVERRIDE;
56 
58  virtual void registerComponents
59  (
60  ) EC_OVERRIDE;
61 
63  virtual EcBoolean equality
64  (
65  const EcXmlObject* other
66  ) const EC_OVERRIDE;
67 
69  virtual EcXmlObject* newObject
70  (
71  ) const EC_OVERRIDE;
72 
74  virtual const EcLightVector& lights
75  (
76  ) const;
77 
79  virtual void setLights
80  (
81  const EcLightVector& lights
82  );
83 
85  virtual const EcToken& token
86  (
87  ) const EC_OVERRIDE;
88 
90  virtual EcBoolean read
91  (
92  EcXmlReader& stream
93  ) EC_OVERRIDE;
94 
96  virtual EcBoolean write
97  (
98  EcXmlWriter& stream
99  ) const EC_OVERRIDE;
100 
102  static EcLightParameters nullObject
103  (
104  );
105 
107  static EcLightParameters defaultObject
108  (
109  );
110 
111 protected:
114 };
115 
116 #endif // ecLightParameters_H_
virtual const EcToken & token() const =0
gets the xml token used for writing out.
#define EC_OVERRIDE
Add wrapper around c++11 override keyword.
Definition: ecMacros.h:36
virtual EcBoolean xmlInit() EC_OVERRIDE
xmlInitialize
An EcString-like class that holds a tag and a namespace.
Definition: ecToken.h:41
A base class for xml objects.
Definition: ecXmlObject.h:23
virtual void registerComponents()=0
register components
virtual EcBoolean read(EcXmlReader &stream) EC_OVERRIDE
read object from an XML stream
An XML object that holds a compound set of XML data.
Definition: ecXmlCompType.h:23
virtual EcBoolean write(EcXmlWriter &stream) const EC_OVERRIDE
write object to an XML stream
virtual EcXmlObject * clone() const =0
clone
bool EcBoolean
Boolean (0 or 1)
Definition: ecTypes.h:21
XML file writer.
Definition: ecXmlWriter.h:19
virtual EcBoolean equality(const EcXmlObject *other) const =0
equality - a virtual equality to an EcXmlObject pointer
virtual EcXmlObject * newObject() const =0
creates new object - a virtual new to an EcXmlObject pointer
An XML file reader.
Definition: ecXmlReader.h:17
Configuration header for the foundation hierarchy.
#define EC_FOUNDATION_VISUALIZATION_DECL
visualization directory
Holds a description of light parameters for viewing the system.
EcLightVector m_Lights
the control expression
Created by Energid Technologies www.energid.com
Copyright © 2016 Energid. All trademarks mentioned in this document are property of their respective owners.