HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM/SIM_GasAdd.h
/*
* Copyright (c) 2018
* Side Effects Software Inc. All rights reserved.
*
* Redistribution and use of Houdini Development Kit samples in source and
* binary forms, with or without modification, are permitted provided that the
* following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. The name of Side Effects Software may not be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
* NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*----------------------------------------------------------------------------
*/
#ifndef __SIM_GasAdd_h__
#define __SIM_GasAdd_h__
#include <GAS/GAS_Utils.h>
namespace HDK_Sample {
/// A simple field manipulation class that will add fields
/// together.
class SIM_GasAdd : public GAS_SubSolver
{
public:
/// These macros are used to create the accessors
/// getFieldDstName and getFieldSrcName functions we'll use
/// to access our data options.
protected:
explicit SIM_GasAdd(const SIM_DataFactory *factory);
virtual ~SIM_GasAdd();
/// Used to determine if the field is complicated enough to justify
/// the overhead of multithreading.
bool shouldMultiThread(const SIM_RawField *field) const
{ return field->field()->numTiles() > 1; }
/// The overloaded callback that GAS_SubSolver will invoke to
/// perform our actual computation. We are giving a single object
/// at a time to work on.
virtual bool solveGasSubclass(SIM_Engine &engine,
SIM_Object *obj,
/// Add two raw fields together. Use UT_ThreadedAlgorithm's macros
/// to define the addFields method that will invoke addFieldPartial()
/// on each worker thread.
addFields,
const SIM_RawField *, src);
private:
/// We define this to be a DOP_Auto node which means we do not
/// need to implement a DOP_Node derivative for this data. Instead,
/// this description is used to define the interface.
static const SIM_DopDescription *getDopDescription();
/// These macros are necessary to bind our node to the factory and
/// ensure useful constants like BaseClass are defined.
DECLARE_STANDARD_GETCASTTOTYPE();
DECLARE_DATAFACTORY(SIM_GasAdd,
"Gas Add",
getDopDescription());
};
} // End HDK_Sample namespace
#endif