SIM_SolverBlend.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_SolverBlend_h__
#define __SIM_SolverBlend_h__

#include "SIM_API.h"
#include <UT/UT_Array.h>
#include "SIM_Solver.h"
#include "SIM_OptionsUser.h"

class SIM_PerObjectBlendData;

/// This solver class passes the solve responsibility to one or more other
/// solvers. It searches for any SIM_Solver subdata attached to itself, and
/// calls each one in turn.
class SIM_API SIM_SolverBlend : public SIM_Solver,
                                public SIM_OptionsUser
{
public:
    GETSET_DATA_FUNCS_S(SIM_NAME_BLENDDATANAME, BlendDataName);
    GETSET_DATA_FUNCS_S(SIM_NAME_BLENDFACTORSROOTNAME, BlendFactorsRootName);
    GETSET_DATA_FUNCS_B(SIM_NAME_MATCHBYNAME, MatchByName);
    GETSET_DATA_FUNCS_I(SIM_NAME_PRIMARYSOLVER, PrimarySolver);

protected:
    /// Basic SIM_SolverBlend constructor.
    explicit             SIM_SolverBlend(const SIM_DataFactory *factory);
    /// Basic SIM_SolverBlend destructor.
                        ~SIM_SolverBlend() 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;
    /// 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;

    /// Gets the SIM_BlendFactor data for all the objects in an array.
    void                 getBlendFactorsSubdata(
                                const SIM_ObjectArray &objects,
                                const char *blenddataname,
                                const char *solverparmsroot,
                                SIM_PerObjectBlendData *blenddata,
                                UT_StringArray *subsolvernames);

private:
    /// Gets the solver parm data for a single object.
    void                 getBlendFactorsSubdata(
                                SIM_Object &object,
                                const char *blenddataname,
                                const char *solverparmsroot,
                                SIM_PerObjectBlendData &blenddata,
                                UT_StringArray *subsolvernames);

    void                 prepareObjectsForSolve(
                                const SIM_ObjectArray &objects,
                                SIM_PerObjectBlendData *blenddata,
                                int solverindex,
                                const char *blenddataname);
    void                 cleanupObjectsAfterSolve(
                                const SIM_ObjectArray &objects,
                                SIM_PerObjectBlendData *blenddata,
                                int solverindex,
                                const char *blenddataname);
    void                 blendAllSolvedData(
                                const SIM_ObjectArray &objects,
                                SIM_PerObjectBlendData *blenddata,
                                int numsolvers,
                                const char *blenddataname);
    /// Gets the solver to use for getting object properties.
    const SIM_Solver                    *getCurrentSolver() const;

    static const SIM_DopDescription     *getSolverBlendDopDescription();

    SIM_Solver                          *myCurrentSolver;

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_SolverBlend,
                        SIM_Solver,
                        "Blend Solver",
                        getSolverBlendDopDescription());
};

#endif