HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ImfTiledInputPart.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2011, Industrial Light & Magic, a division of Lucas
4 // Digital Ltd. LLC
5 //
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions are
10 // met:
11 // * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 // * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 // * Neither the name of Industrial Light & Magic nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 ///////////////////////////////////////////////////////////////////////////
34 
35 #ifndef IMFTILEDINPUTPART_H_
36 #define IMFTILEDINPUTPART_H_
37 
38 #include "ImfMultiPartInputFile.h"
39 #include "ImfTiledInputFile.h"
40 #include "ImfNamespace.h"
41 #include "ImfForward.h"
42 #include "ImfExport.h"
43 
45 
46 //-----------------------------------------------------------------------------
47 // class TiledInputPart:
48 //
49 // Same interface as TiledInputFile. Please have a reference to TiledInputFile.
50 //-----------------------------------------------------------------------------
51 
53 {
54  public:
55  TiledInputPart(MultiPartInputFile& multiPartFile, int partNumber);
56 
57  const char * fileName () const;
58  const Header & header () const;
59  int version () const;
60  void setFrameBuffer (const FrameBuffer &frameBuffer);
61  const FrameBuffer & frameBuffer () const;
62  bool isComplete () const;
63  unsigned int tileXSize () const;
64  unsigned int tileYSize () const;
65  LevelMode levelMode () const;
66  LevelRoundingMode levelRoundingMode () const;
67  int numLevels () const;
68  int numXLevels () const;
69  int numYLevels () const;
70  bool isValidLevel (int lx, int ly) const;
71  int levelWidth (int lx) const;
72  int levelHeight (int ly) const;
73  int numXTiles (int lx = 0) const;
74  int numYTiles (int ly = 0) const;
75  IMATH_NAMESPACE::Box2i dataWindowForLevel (int l = 0) const;
76  IMATH_NAMESPACE::Box2i dataWindowForLevel (int lx, int ly) const;
77  IMATH_NAMESPACE::Box2i dataWindowForTile (int dx, int dy, int l = 0) const;
78  IMATH_NAMESPACE::Box2i dataWindowForTile (int dx, int dy,
79  int lx, int ly) const;
80  void readTile (int dx, int dy, int l = 0);
81  void readTile (int dx, int dy, int lx, int ly);
82  void readTiles (int dx1, int dx2, int dy1, int dy2,
83  int lx, int ly);
84  void readTiles (int dx1, int dx2, int dy1, int dy2,
85  int l = 0);
86  void rawTileData (int &dx, int &dy,
87  int &lx, int &ly,
88  const char *&pixelData,
89  int &pixelDataSize);
90 
91  private:
92  TiledInputFile* file;
93  // for internal use - allow TiledOutputFile access to file for copyPixels
94  friend class TiledOutputFile;
95 
96 };
97 
99 
100 #endif /* IMFTILEDINPUTPART_H_ */
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
Definition: ImfNamespace.h:109
Box< V2i > Box2i
Definition: ImathBox.h:133
LevelRoundingMode
#define IMF_EXPORT
Definition: ImfExport.h:59
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
Definition: ImfNamespace.h:108