HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
FilmBackXformOp.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2011,
4 // Sony Pictures Imageworks, Inc. and
5 // Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
6 //
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are
11 // met:
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above
15 // copyright notice, this list of conditions and the following disclaimer
16 // in the documentation and/or other materials provided with the
17 // distribution.
18 // * Neither the name of Sony Pictures Imageworks, nor
19 // Industrial Light & Magic nor the names of their contributors may be used
20 // to endorse or promote products derived from this software without specific
21 // prior written permission.
22 //
23 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 //
35 //-*****************************************************************************
36 
37 #ifndef Alembic_AbcGeom_FilmBackXformOp_h
38 #define Alembic_AbcGeom_FilmBackXformOp_h
39 
40 #include <Alembic/Util/Export.h>
42 
43 namespace Alembic {
44 namespace AbcGeom {
45 namespace ALEMBIC_VERSION_NS {
46 
47 //! \brief FilmBack Xform Operation
48 //! This class holds the data about a particular transform operation, but does
49 //! not hold the actual data to calculate a 3x3 matrix. It holds the type of
50 //! operation (Translate, Scale, Matrix), a hint about the type which
51 //! can be interpreted by packages like Maya, and what particular parts of the
52 //! operations can change over time.
54 {
55 public:
57 
59  const std::string & iHint );
60 
61  //! Get the type of transform operation. (Translate, Scale, Matrix)
62  FilmBackXformOperationType getType() const;
63 
64  //! Get the hint to help disambiguate certain options that may have the
65  //! same type.
66  std::string getHint() const;
67 
68  //! Get the type and hint, where the first character is the type
69  //! (t for translate, s for scale, m for matrix) and the rest of the
70  //! returned string is the optional hint value.
71  std::string getTypeAndHint() const;
72 
73  //! Get the number of components that this operation has based on the type.
74  //! Translate and Scale have 2, and Matrix has 9.
75  std::size_t getNumChannels() const;
76 
77  //! Get a single channel, 0 will be returned if iIndex is greater than
78  //! numChannels - 1
79  double getChannelValue( std::size_t iIndex ) const;
80 
81  //! Set a single channel; nothing will be set if iIndex is greater than
82  //! numChannels - 1.
83  void setChannelValue( std::size_t iIndex, double iVal );
84 
85  void setTranslate( const Abc::V2d &iTrans );
86  void setScale( const Abc::V2d &iScale );
87  void setMatrix( const Abc::M33d &iMatrix );
88 
89  // synthetic getters return by value
90  Abc::V2d getTranslate() const;
91  Abc::V2d getScale() const;
92  Abc::M33d getMatrix() const;
93 
94  bool isTranslateOp() const;
95 
96  bool isScaleOp() const;
97 
98  bool isMatrixOp() const;
99 
100 private:
101 
102  // friend to have access to the private constructor
103  friend class ICameraSchema;
104  FilmBackXformOp( const std::string & iTypeAndHint );
105 
107  std::string m_hint;
108 
109  std::vector<double> m_channels;
110 
111 };
112 
113 } // End namespace ALEMBIC_VERSION_NS
114 
115 using namespace ALEMBIC_VERSION_NS;
116 
117 } // End namespace AbcGeom
118 } // End namespace Alembic
119 
120 #endif
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
FilmBack Xform Operation This class holds the data about a particular transform operation, but does not hold the actual data to calculate a 3x3 matrix. It holds the type of operation (Translate, Scale, Matrix), a hint about the type which can be interpreted by packages like Maya, and what particular parts of the operations can change over time.
Matrix33< double > M33d
Definition: ImathMatrix.h:864
Vec2< double > V2d
Definition: ImathVec.h:690
FilmBackXformOperationType
Enum that indicates the type of 2d operation for cameras. This enum is used when encoding and decodin...
Definition: Foundation.h:85
Vec3< typename MatType::value_type > getScale(const MatType &mat)
Return a Vec3 representing the lengths of the passed matrix's upper 3×3's rows.
Definition: Mat.h:665
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105