HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GABC_OProperty.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) COPYRIGHTYEAR
3  * Side Effects Software Inc. All rights reserved.
4  *
5  * Redistribution and use of Houdini Development Kit samples in source and
6  * binary forms, with or without modification, are permitted provided that the
7  * following conditions are met:
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. The name of Side Effects Software may not be used to endorse or
11  * promote products derived from this software without specific prior
12  * written permission.
13  *
14  * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
15  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
17  * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
19  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
20  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
21  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
22  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  *----------------------------------------------------------------------------
26  */
27 
28 #ifndef __GABC_OProperty__
29 #define __GABC_OProperty__
30 
31 #include "GABC_API.h"
32 #include "GABC_Include.h"
33 #include "GABC_OError.h"
34 #include "GABC_LayerOptions.h"
35 #include <Alembic/AbcGeom/All.h>
36 #include <GT/GT_Handles.h>
37 #include <GT/GT_Types.h>
38 
39 namespace GABC_NAMESPACE
40 {
41 
42 class GABC_OOptions;
43 
44 /// Base class for exporting attribute and user property data from a
45 /// GT_DataArray to Alembic.
46 ///
47 /// The Alembic equivalent of attributes are Alembic arbitrary geometry
48 /// parameters (arbGeomParams). In addition, Alembic geometry can have user
49 /// properties which have no direct equivalent in Houdini. We store user
50 /// properties as a JSON dictionary exposed to users through a special
51 /// attribute (see: GABC_Util::theUserPropsValsAttrib).
52 ///
53 /// User properties are stored using OScalarProperty and OArrayProperty
54 /// objects, while arbGeomParams are stored using OGeomParam objects which
55 /// contain an underlying OArrayProperty.
56 ///
57 /// The children derived from this base class write data representing
58 /// attributes and user properties from GT_DataArray objects to the appropriate
59 /// type of OProperty.
60 ///
62 {
63 public:
66 
68  : myLayerType(ltype) {}
69  virtual ~GABC_OProperty() {}
70 
71  /// Creates the appropriate child object, based on the array's storage
72  /// type, tuple size, and interpretation, and the Alembic POD (if provided)
73  virtual bool start(OCompoundProperty &parent,
74  const char *name,
75  const GT_DataArrayHandle &array,
76  GABC_OError &err,
77  const GABC_OOptions &options,
78  const PlainOldDataType pod
80 
81  /// Write GT_DataArray conents as samples to the property.
82  virtual bool update(const GT_DataArrayHandle &array,
83  GABC_OError &err,
84  const GABC_OOptions &options,
85  const PlainOldDataType pod
87 
88  /// Reuse the previous sample .
89  virtual bool updateFromPrevious() = 0;
90 
91  /// Get number of samples written to property so far.
92  virtual exint getNumSamples() const = 0;
93 
94 protected:
100  void *myBuffer;
102 };
103 
104 } // GABC_NAMESPACE
105 
106 #endif
GT_Storage
Definition: GT_Types.h:17
GABC_OProperty(GABC_LayerOptions::LayerType ltype)
GLuint start
Definition: glcorearb.h:474
GT_Type
Definition: GT_Types.h:33
Alembic::Abc::OCompoundProperty OCompoundProperty
#define GABC_NAMESPACE
Definition: GABC_API.h:42
int64 exint
Definition: SYS_Types.h:116
GLuint const GLchar * name
Definition: glcorearb.h:785
#define GABC_API
Definition: GABC_API.h:37
Alembic::Util::PlainOldDataType PlainOldDataType
int64 GT_Size
Definition: GT_Types.h:112
GABC_LayerOptions::LayerType myLayerType