SIM/SIM_SolverSwitch.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:
 *      Side Effects Software Inc.
 *      477 Richmond Street West, Suite 1001
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 */

#ifndef __SIM_SolverSwitch_h__
#define __SIM_SolverSwitch_h__

#include "SIM_API.h"
#include "SIM_Solver.h"
#include "SIM_OptionsUser.h"

/// 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_SolverSwitch : public SIM_Solver,
                                 public SIM_OptionsUser
{
public:
    GETSET_DATA_FUNCS_S(SIM_NAME_SWITCHVALUENAME, SwitchValueName);
    GETSET_DATA_FUNCS_I(SIM_NAME_DEFAULTSWITCHVALUE, DefaultSwitchValue);

protected:
    /// Basic SIM_SolverSwitch constructor.
    explicit             SIM_SolverSwitch(const SIM_DataFactory *factory);
    /// Basic SIM_SolverSwitch destructor.
    virtual             ~SIM_SolverSwitch();

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

private:
    int                  getSubSolverAssignment(const SIM_Object &object,
                                SIM_ConstSolverArray &subsolvers,
                                const char *switchvaluename) const;
    void                 getSubSolverAssignments(SIM_ObjectArray &objects,
                                SIM_SolverArray &subsolvers,
                                const char *switchvaluename,
                                UT_RefArray<SIM_ObjectArray> &ssobjs);

    static const SIM_DopDescription     *getSolverSwitchDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_SolverSwitch,
                        SIM_Solver,
                        "Switch Solver",
                        getSolverSwitchDopDescription());
};

#endif

---