Cortex  10.0.0-a4
ParticleReader.h
1 //
3 // Copyright (c) 2007-2011, 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 IE_CORE_PARTICLEREADER_H
36 #define IE_CORE_PARTICLEREADER_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/Reader.h"
40 #include "IECore/SimpleTypedParameter.h"
41 #include "IECore/VectorTypedParameter.h"
42 #include "IECore/NumericParameter.h"
43 
44 namespace IECore
45 {
46 
52 class IECORE_API ParticleReader : public Reader
53 {
54 
55  public :
56 
57  IE_CORE_DECLARERUNTIMETYPED( ParticleReader, Reader );
58 
59  ParticleReader( const std::string &description );
60 
62  enum RealType
63  {
64  Native = 0,
65  Float = 1,
66  Double = 2,
67  };
68 
73 
74  FloatParameter * percentageParameter();
75  const FloatParameter * percentageParameter() const;
76  IntParameter * percentageSeedParameter();
77  const IntParameter * percentageSeedParameter() const;
78  StringVectorParameter * attributesParameter();
79  const StringVectorParameter * attributesParameter() const;
80  IntParameter * realTypeParameter();
81  const IntParameter * realTypeParameter() const;
82  BoolParameter * convertPrimVarNamesParameter();
83  const BoolParameter * convertPrimVarNamesParameter() const;
85 
92 
93  virtual unsigned long numParticles() = 0;
99  virtual void attributeNames( std::vector<std::string> &names ) = 0;
104  virtual DataPtr readAttribute( const std::string &name ) = 0;
106 
107  protected :
108 
114  ObjectPtr doOperation( const CompoundObject * operands ) override;
115 
120  float particlePercentage() const;
121  FloatParameterPtr m_percentageParameter;
122  int particlePercentageSeed() const;
123  IntParameterPtr m_percentageSeedParameter;
124  void particleAttributes( std::vector<std::string> &names );
125  StringVectorParameterPtr m_attributesParameter;
126  RealType realType() const;
127  IntParameterPtr m_realTypeParameter;
128  bool convertPrimVarNames() const;
129  BoolParameterPtr m_convertPrimVarNamesParameter;
130 
134  template<typename T, typename F>
135  typename T::Ptr filterAttr( const F * attr, float percentage, const Data *idAttr ) const;
136 
138  virtual std::string positionPrimVarName() = 0;
139 
140  private :
141 
142  template<typename T, typename F, typename U >
143  typename T::Ptr filterAttr( const F * attr, float percentage, const std::vector< U > &ids ) const;
144 
145 
146 };
147 
148 IE_CORE_DECLAREPTR( ParticleReader );
149 
150 } // namespace IECore
151 
152 #endif // IE_CORE_PARTICLEREADER_H
Definition: Reader.h:56
Definition: Data.h:46
Definition: TypedParameter.h:48
Definition: CompoundObject.h:46
Definition: NumericParameter.h:48
Definition: ParticleReader.h:52
RealType
An enum for the values accepted by realTypeParameter().
Definition: ParticleReader.h:62
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43