HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GABC_OArrayProperty.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_OArrayProperty__
29 #define __GABC_OArrayProperty__
30 
31 #include "GABC_API.h"
32 #include "GABC_Include.h"
33 #include "GABC_OProperty.h"
34 #include <Alembic/AbcGeom/All.h>
35 #include <GT/GT_Handles.h>
36 #include <GT/GT_Types.h>
37 
38 namespace GABC_NAMESPACE
39 {
40 
41 class GABC_OError;
42 class GABC_OOptions;
43 
44 /// Class for exporting attribute and user property data from a
45 /// GT_DataArray to an OArrayProperty.
46 ///
47 /// See GABC_OProperty for more details.
48 ///
50 {
51 public:
54 
56 
58 
59  /// This constructor is used if we're creating a user property.
61  : GABC_OProperty(ltype)
62  , myScope(Alembic::AbcGeom::kUnknownScope)
63  , myIsGeomParam(false)
64  {}
65  /// This constructor is used if we're creating an attribute.
67  GeometryScope scope)
68  : GABC_OProperty(ltype)
69  , myScope(scope)
70  , myIsGeomParam(true)
71  {}
72 
74 
75  /// See GABC_OProperty for information about methods.
76  bool start(OCompoundProperty &parent,
77  const char *name,
78  const GT_DataArrayHandle &array,
79  GABC_OError &err,
80  const GABC_OOptions &options,
81  const PlainOldDataType pod =
83  bool update(const GT_DataArrayHandle &array,
84  GABC_OError &err,
85  const GABC_OOptions &options,
86  const PlainOldDataType pod
88  bool updateFromPrevious();
90  {
91  return myProperty.getNumSamples();
92  }
93 
94 private:
95  GeometryScope myScope;
96  OArrayProperty myProperty;
97  OUInt32ArrayProperty myIndexProperty;
98  bool myIsGeomParam;
99 };
100 
101 } // GABC_NAMESPACE
102 
103 #endif
GLuint start
Definition: glcorearb.h:474
#define GABC_NAMESPACE
Definition: GABC_API.h:42
int64 exint
Definition: SYS_Types.h:116
GABC_OArrayProperty(GABC_LayerOptions::LayerType ltype, GeometryScope scope)
This constructor is used if we're creating an attribute.
exint getNumSamples() const
Get number of samples written to property so far.
GLuint const GLchar * name
Definition: glcorearb.h:785
GABC_OArrayProperty(GABC_LayerOptions::LayerType ltype)
This constructor is used if we're creating a user property.
#define GABC_API
Definition: GABC_API.h:37
OTypedArrayProperty< Uint32TPTraits > OUInt32ArrayProperty