SIM_BuildCollisionMaskFromPieces.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        SIM_BuildCollisionMaskFromPieces.h (SIMZ Library, C++)
 *
 * COMMENTS:
 *  Implements an operator to build a collision mask (and a field of collision
 *  velocities) from instanced rigid body pieces.
 */

#ifndef __SIM_BuildCollisionMaskFromPieces__
#define __SIM_BuildCollisionMaskFromPieces__

#include "SIMZ_API.h"

#include <GAS/GAS_SubSolver.h>
#include <SIM/SIM_RawField.h>

class sim_ColliderInstance;

// This class implements the collision mask building logic.
class SIMZ_API SIM_BuildCollisionMaskFromPieces : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_COLLISION, CollisionField);
    GET_DATA_FUNC_S(GAS_NAME_COLLISIONVELOCITY, CollisionVelocity);
    GET_DATA_FUNC_S(GAS_NAME_STENCIL, StencilField);

    GET_DATA_FUNC_V3("wind", WindVelocity);

    GET_DATA_FUNC_B("clearmask", ClearMask);
    GET_DATA_FUNC_F("minmaskval", StartingValue);

    GET_DATA_FUNC_I("referenceframe", CollectFrame);
    GET_DATA_FUNC_I("input", Input);
    GET_DATA_FUNC_S("soppath", SopPath);
    GET_DATA_FUNC_S("instgeo", InstanceGeo);

    GET_DATA_FUNC_S("surfvol", SurfaceVolume);

protected:
    explicit SIM_BuildCollisionMaskFromPieces(const SIM_DataFactory* factory);
            ~SIM_BuildCollisionMaskFromPieces() override;

    bool solveGasSubclass(SIM_Engine& engine,
                          SIM_Object* obj,
                          SIM_Time time,
                          SIM_Time timestep) override;

    THREADED_METHOD7_CONST(SIM_BuildCollisionMaskFromPieces,
                           mask->shouldMultiThread(),
                           buildCollisionMask,
                           SIM_RawField*, mask,
                           UT_VoxelArrayF**, vel,
                           const SIM_RawField*, stencil,
                           const UT_Array<sim_ColliderInstance>&, colliders,
                           bool, clear,
                           float, def_val,
                           const UT_Vector3&, neg_wind);
    void buildCollisionMaskPartial(SIM_RawField* mask, UT_VoxelArrayF* vel[3],
                                   const SIM_RawField* stencil,
                                   const UT_Array<sim_ColliderInstance>& cs,
                                   bool clear, float def_val,
                                   const UT_Vector3& neg_wind,
                                   const UT_JobInfo& info) const;
 
private:
    static const SIM_DopDescription* getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_BuildCollisionMaskFromPieces, GAS_SubSolver,
                        "Gas Build Collision Mask From Pieces",
                        getDopDescription());
};

#endif