Cortex  10.0.0-a4
ParameterList.h
1 //
3 // Copyright (c) 2007-2010, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECORERI_PARAMETERLIST_H
36 #define IECORERI_PARAMETERLIST_H
37 
38 #include "IECore/Renderer.h"
39 
40 #include "IECoreRI/Export.h"
41 
42 namespace IECoreRI
43 {
44 
47 class IECORERI_API ParameterList
48 {
49 
50  public :
51 
62  ParameterList( const IECore::CompoundDataMap &parameters,
63  const std::map<std::string, std::string> *typeHints = nullptr );
66  ParameterList( const IECore::CompoundDataMap &parameters, const std::string &prefix,
67  const std::map<std::string, std::string> *typeHints = nullptr );
69  ParameterList( const std::string &name, const IECore::Data *parameter,
70  const std::map<std::string, std::string> *typeHints = nullptr );
71 
72  ~ParameterList();
73 
76  int n();
80  char **tokens();
84  void **values();
85 
86  private :
87 
88  const char *type( const std::string &name, const IECore::Data *d, bool &isArray, size_t &arraySize, const std::map<std::string, std::string> *typeHints );
89  const void *value( const IECore::Data *d );
90 
91  // Methods for building strings:
92  inline int numPlaces( size_t n );
93  inline void appendInt( char *&str, size_t n );
94  inline void appendString( char *&str, const char* toAppend, size_t len );
95  inline void appendString( char *&str, const std::string &toAppend );
96  inline void buildPositionsString( char*& str, const std::string& name, size_t arraySize );
97  inline void buildColorValuesString( char*& str, const std::string& name, size_t arraySize );
98  inline void buildFloatValuesString( char*& str, const std::string& name, size_t arraySize );
99 
100  // Call one of these to reserve enough space in the arrays below to represent all the parameters.
101  void reserve( const IECore::CompoundDataMap &parameters );
102  void reserve( const IECore::Data *parameter );
103  void accumulateReservations( const IECore::Data *d, size_t &numStrings, size_t &numCharPtrs, size_t &numInts, size_t &numFloats );
104  // Then call this n times to populate the member data
105  void appendParameter( const std::string &name, const IECore::Data *d, const std::map<std::string, std::string> *typeHints );
106  std::vector<const char *> m_charPtrs;
107  std::vector<int> m_ints;
108  std::vector<float> m_floats;
109  std::vector<char *> m_tokens;
110  std::vector<const void *> m_values;
111 
112  static const IECore::InternedString g_handleParameterName;
113 
114 };
115 
116 } // namespace IECoreRI
117 
118 #endif // IECORERI_PARAMETERLIST_H
Definition: Data.h:46
Definition: ParameterList.h:47
The IECoreRI namespace holds all the functionality implemented in libIECoreRI.
Definition: IECoreRI.h:41
Definition: InternedString.h:55
std::map< InternedString, DataPtr > CompoundDataMap
The type of Data held by the CompoundData typedef.
Definition: CompoundDataBase.h:46