GAS/GAS_AdjustParticleCoordinates.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.
 *
 * Produced by:
 *      Jeff Chadwick
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        GAS_AdjustElasticity.h ( GAS Library, C++)
 *
 * COMMENTS:    This node is used to adjust and reinitialize
 *              a coordinate system attached to the particles
 *              in a particle fluid simulation.
 *
 */

#ifndef __GAS_AdjustParticleCoordinates__
#define __GAS_AdjustParticleCoordinates__

#include "GAS_API.h"

#include "GAS_SubSolver.h"
#include "GAS_Utils.h"

class GEO_AttributeHandle;
class GU_Detail;
class UT_BoundingBox;

class GAS_API GAS_AdjustParticleCoordinates : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_GEOMETRY,  GeometryName);

protected:
    explicit             GAS_AdjustParticleCoordinates(const SIM_DataFactory *factory);
    virtual             ~GAS_AdjustParticleCoordinates();

    /// Performs any necessary adjustments to the coordinate
    /// system attached to the fluid particles.
    virtual bool         solveGasSubclass(SIM_Engine &engine,
                                    SIM_Object *obj,
                                    SIM_Time time,
                                    SIM_Time timestep);

private:
    /// Populates the provided attribute handles, and returns
    /// false if any attribute does not exist.
    bool                 getAttributes(GU_Detail *gdp,
                                    GEO_AttributeHandle &bboxMinGah,
                                    GEO_AttributeHandle &bboxMaxGah,
                                    GEO_AttributeHandle &coordinateScaleGah,
                                    GEO_AttributeHandle &transitionStateGah,
                                    GEO_AttributeHandle &periodGah,
                                    GEO_AttributeHandle &transitionLengthGah,
                                    GEO_AttributeHandle &coordinate1Gah,
                                    GEO_AttributeHandle &coordinate2Gah,
                                    GEO_AttributeHandle &lastAdjustGah);

    /// Initializes a new coordinate system for the fluid.
    void                 initNewCoordinates(GU_Detail *gdp,
                                    const UT_BoundingBox &bbox,
                                    const UT_Vector3 &coordinateScales,
                                    GEO_AttributeHandle &coordinateGah);

    /// Swaps the coordinate systems.
    void                 swapCoordinates(GU_Detail *gdp,
                                    GEO_AttributeHandle &coordinate1Gah,
                                    GEO_AttributeHandle &coordinate2Gah);

    static const SIM_DopDescription     *getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_AdjustParticleCoordinates,
                        GAS_SubSolver,
                        "Gas Adjust Particle Coordinates",
                        getDopDescription());
};

#endif

---