SIM_SolverEnable.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.
 *
 */

#ifndef __SIM_SolverEnable_h__
#define __SIM_SolverEnable_h__

#include "SIM_API.h"
#include "SIM_Solver.h"
#include "SIM_Query.h"
#include "SIM_QueryCombine.h"
#include "SIM_SolverEnableParms.proto.h"

#include <UT/UT_StringHolder.h>
#include <UT/UT_UniquePtr.h>

class SIM_SolverEnableTestCache;
class SIM_DataFilterRootData;

/// This solver class passes the solve responsibility to one or more other
/// solvers. It searches for any SIM_Solver subdata attached to itself, and
/// and calls the one that matches the object's swithch value.
class SIM_API SIM_SolverEnable : public SIM_Solver
{
public:
    SIM_SolverEnableParms       &param() { return myParms; }
    const SIM_SolverEnableParms &param() const { return myParms; }

    OP_VERSION                   versionParms() const { return myVersion; }
    void                         setVersionParms(OP_VERSION version) { myVersion = version; }

    void                         clearCachedSubdata() const
    { mySolverListCached = false; mySolverList.clear(); }

protected:

    class TestCache
    {
    public:
        void            update(const SIM_SolverEnableParms &parms);
        bool            test(const SIM_SolverEnableParms &parms, const SIM_RootData *object);
    protected:
        UT_StringHolder myObjectPatternCache;
        UT_StringHolder myDataNamesCache;
        UT_StringHolder myAttribNamesCache;
        UT_StringHolder myFieldNamesCache;

        UT_UniquePtr<SIM_DataFilterRootData> myObjectFilter;
        UT_StringArray  myParsedData;
        UT_StringArray  myParsedAttrib;
        SIM_ConstDataArray myData;
        UT_StringArray  myParsedField;
    };

    /// Basic SIM_SolverEnable constructor.
    explicit             SIM_SolverEnable(const SIM_DataFactory *factory);
    /// Basic SIM_SolverEnable destructor.
                        ~SIM_SolverEnable() override;

    /// Creates a SIM_QueryArrays object to treat impact as a record
    SIM_Query           *createQueryObjectSubclass() const override
    {
        return new SIM_QueryCombine(BaseClass::createQueryObjectSubclass(), param().createQueryObject(this));
    }
    void makeEqualSubclass(const SIM_Data *source) override
    {
        BaseClass::makeEqualSubclass(source);
        const SIM_SolverEnable *src = SIM_DATA_CASTCONST(source, SIM_SolverEnable);
        if (src)
        {
            param() = src->param();
            setVersionParms(src->versionParms());
        }
    }
    void saveSubclass(std::ostream &os) const override
    {
        BaseClass::saveSubclass(os);
        myParms.save(os);
    } 
    bool loadSubclass(UT_IStream &is) override
    {
        if (!BaseClass::loadSubclass(is))
            return false;
        if (!myParms.load(is))
            return false;
        return true;
    }
    bool         enableSolvers(const SIM_RootData *object) const;

    /// We are static if our switch is invalid or our input is.
    bool         isStaticSubclass(const SIM_Object *obj) const override;

    /// Override this function to pass this call along to our child solvers.
    SIM_Result   solveObjectsSubclass(
                        SIM_Engine &engine,
                        SIM_ObjectArray &objects,
                        SIM_ObjectArray &newobjects,
                        SIM_ObjectArray &feedbacktoobjects,
                        const SIM_Time &timestep) override;
    SIM_Result   solveRelationshipSubclass(
                        SIM_Engine &engine,
                        SIM_Relationship &relation,
                        const SIM_Time &timestep) override;
    /// Override this function to get the requirements of our child solvers.
    int          getRequestedCacheSubclass() const override;
    void         getImpulseMassMatrixSubclass(
                        const SIM_Object &object,
                        const UT_Vector3 &impulseworldpos,
                        UT_DMatrix3 &immatrix) const override;
    void         getPointImpulseMassMatrixSubclass(
                        const SIM_Object &object,
                        int ptnum, UT_DMatrix3 &immatrix) const override;
    SIM_PointImpulseMassMatrixResolver
                *getPointImpulseMassMatrixResolverSubclass(
                        const SIM_Object &object) const override;
    fpreal       getPropertyAtPositionSubclass(
                        const SIM_Object &object,
                        const UT_Vector3 &worldpos,
                        const SIM_Property &property) const override;
    fpreal       getPropertyAtPointSubclass(
                        const SIM_Object &object,
                        int ptnum,
                        const SIM_Property &property) const override;
    void         getDefaultColliderLabelSubclass(
                        const SIM_Object &object,
                        UT_String &label) const override;
    void         getDefaultColliderSubclass(
                        const SIM_Object &object,
                        const UT_String &colliderlabel,
                        UT_String &collidertype,
                        bool &colliderreverseobjectroles) const override;

private:
    static const SIM_DopDescription     *getSolverEnableDopDescription();

    SIM_Solver                          *myCurrentSolver;
    SIM_SolverEnableParms               myParms;
    OP_VERSION                  myVersion;

    mutable bool                                mySolverListCached;
    mutable SIM_SolverArray                     mySolverList;
    mutable TestCache           myTestCache;

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_SolverEnable,
                        SIM_Solver,
                        "Enable Solver",
                        getSolverEnableDopDescription());
};

#endif