HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GABC_OScalarProperty.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_OScalarProperty__
29 #define __GABC_OScalarProperty__
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 user property data from a GT_DataArray to an
45 /// OScalarProperty.
46 ///
47 /// See GABC_OProperty for more details.
48 ///
50 {
51 public:
54 
56 
59 
60  /// true if 'array' can be represented as an Alembic scalar
61  static bool isValidScalarData(const GT_DataArrayHandle &array);
62 
63  /// See GABC_OProperty for information about methods.
64  bool start(OCompoundProperty &parent,
65  const char *name,
66  const GT_DataArrayHandle &array,
67  GABC_OError &err,
68  const GABC_OOptions &options,
69  const PlainOldDataType pod =
71  bool update(const GT_DataArrayHandle &array,
72  GABC_OError &err,
73  const GABC_OOptions &options,
74  const PlainOldDataType pod
76  bool updateFromPrevious();
78  {
79  return myProperty.getNumSamples();
80  }
81 
82 private:
83  OScalarProperty myProperty;
84  void *myBuffer;
85 };
86 
87 } // GABC_NAMESPACE
88 
89 #endif
GLuint start
Definition: glcorearb.h:474
#define GABC_NAMESPACE
Definition: GABC_API.h:42
exint getNumSamples() const
Get number of samples written to property so far.
int64 exint
Definition: SYS_Types.h:109
GLuint const GLchar * name
Definition: glcorearb.h:785
#define GABC_API
Definition: GABC_API.h:37
Alembic::Abc::OScalarProperty OScalarProperty
Alembic::Util::PlainOldDataType PlainOldDataType
Alembic::Abc::OCompoundProperty OCompoundProperty