simpmod.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2006 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// FILE:        simpmod.h
// DESCRIPTION: Simple modifier base class
// AUTHOR:      Dan Silva & Rolf Berteig
// HISTORY:     created 30 January, 1995
//**************************************************************************/
#pragma once

#include "object.h"
// forward declarations
class MoveModBoxCMode;
class RotateModBoxCMode;
class UScaleModBoxCMode;
class NUScaleModBoxCMode;
class SquashModBoxCMode;

//--- SimpleMod -----------------------------------------------------------

class SimpleMod: public Modifier {
    protected:
        CoreExport virtual ~SimpleMod();

    public: 
        Control *tmControl;
        Control *posControl;
        IParamBlock *pblock;
                
        CoreExport static IObjParam *ip;
        static MoveModBoxCMode *moveMode;
        static RotateModBoxCMode *rotMode;
        static UScaleModBoxCMode *uscaleMode;
        static NUScaleModBoxCMode *nuscaleMode;
        static SquashModBoxCMode *squashMode;       
        static SimpleMod *editMod;
            
        CoreExport SimpleMod();


        ChannelMask ChannelsUsed()  { return PART_GEOM|PART_TOPO|SELECT_CHANNEL|SUBSEL_TYPE_CHANNEL; }
        ChannelMask ChannelsChanged() { return PART_GEOM; }
        CoreExport void ModifyObject(TimeValue t, ModContext &mc, ObjectState *os, INode *node);
        Class_ID InputType() {return defObjectClassID;}
        CoreExport Interval LocalValidity(TimeValue t);
        CoreExport Matrix3 CompMatrix(TimeValue t, ModContext& mc, Matrix3& ntm, 
            Interval& valid, BOOL needOffset);
        CoreExport void CompOffset( TimeValue t, Matrix3& offset, Matrix3& invoffset);

        // From BaseObject
        CoreExport int HitTest(TimeValue t, INode* inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext* mc);
        CoreExport int Display(TimeValue t, INode* inode, ViewExp *vpt, int flagst, ModContext *mc);
        CoreExport void GetWorldBoundBox(TimeValue t,INode* inode, ViewExp *vpt, Box3& box, ModContext *mc);
        
        CoreExport void GetSubObjectCenters(SubObjAxisCallback *cb,TimeValue t,INode *node,ModContext *mc);
        CoreExport void GetSubObjectTMs(SubObjAxisCallback *cb,TimeValue t,INode *node,ModContext *mc);
        BOOL ChangeTopology() {return FALSE;}

        CoreExport IParamArray *GetParamBlock();
        CoreExport int GetParamBlockIndex(int id);

        // Affine transform methods
        CoreExport void Move( TimeValue t, Matrix3& partm, Matrix3& tmAxis, Point3& val, BOOL localOrigin=FALSE );
        CoreExport void Rotate( TimeValue t, Matrix3& partm, Matrix3& tmAxis, Quat& val, BOOL localOrigin=FALSE );
        CoreExport void Scale( TimeValue t, Matrix3& partm, Matrix3& tmAxis, Point3& val, BOOL localOrigin=FALSE );
        
        int NumRefs() {return 3;}
        CoreExport RefTargetHandle GetReference(int i);
protected:
        CoreExport virtual void SetReference(int i, RefTargetHandle rtarg);
public:

        int NumSubs() {return 3;}
        CoreExport Animatable* SubAnim(int i);
        CoreExport MSTR SubAnimName(int i);
        CoreExport int SubNumToRefNum(int subNum);
        CoreExport BOOL AssignController(Animatable *control,int subAnim);

        CoreExport RefResult NotifyRefChanged( Interval changeInt,RefTargetHandle hTarget, 
           PartID& partID, RefMessage message);

        CreateMouseCallBack* GetCreateMouseCallBack() {return NULL;} 
        CoreExport void ActivateSubobjSel(int level, XFormModes& modes);

        // When clients are cloning themselves, they should call this 
        // method on the clone to copy SimpleMod's data.
        // NOTE: DEPRECATED! Use SimpleModClone(SimpleMod *smodSource, RemapDir& remap )
        CoreExport void SimpleModClone(SimpleMod *smodSource);

        // When clients are cloning themselves, they should call this 
        // method on the clone to copy SimpleMod's data.
        CoreExport void SimpleModClone(SimpleMod *smodSource, RemapDir& remap );

        // Clients of simpmod probably want to override these. If they do
        // the should call these from within thier methods.
        CoreExport void BeginEditParams(IObjParam *ip, ULONG flags,Animatable *prev);
        CoreExport void EndEditParams(IObjParam *ip, ULONG flags,Animatable *next);

        // Clients of simpmod need to implement this method
        virtual Deformer& GetDeformer(TimeValue t,ModContext &mc,Matrix3& mat,Matrix3& invmat)=0;
        virtual void InvalidateUI() {}
        #pragma warning(push)
        #pragma warning(disable:4100)

        virtual Interval GetValidity(TimeValue t) {return FOREVER;}
        virtual ParamDimension *GetParameterDim(int pbIndex) {return defaultDim;}
        virtual MSTR GetParameterName(int pbIndex) {return MSTR(_M("Parameter"));}
        virtual BOOL GetModLimits(TimeValue t,float &zmin, float &zmax, int &axis) {return FALSE;}
        
        CoreExport int NumSubObjTypes();
        CoreExport ISubObjType *GetSubObjType(int i);
    };


// This is the ref ID of the parameter block
#define SIMPMOD_PBLOCKREF   2

// ParamBlock2 specialization added JBW 2/9/99 (replaces a IParamBlock with IParamBlock2 block pointer)
class IParamBlock2;
class SimpleMod2 : public SimpleMod {
    protected:
        // \brief Destructor. This is a base class that is not meant to be instantiated directly.
        CoreExport virtual ~SimpleMod2();

    public:
        IParamBlock2* pblock2;

        SimpleMod2() { pblock2 = NULL; }
        // From ref
        CoreExport RefTargetHandle GetReference(int i);
protected:
        CoreExport virtual void SetReference(int i, RefTargetHandle rtarg);     
public:
        CoreExport Animatable* SubAnim(int i);
    };

//--- SimpleWSMMod -----------------------------------------------------------

class SimpleWSMMod: public Modifier {   
    public:
        WSMObject   *obRef;
        INode       *nodeRef;
        IParamBlock *pblock;
                
        CoreExport static IObjParam *ip;
        static SimpleWSMMod *editMod;
    
        CoreExport SimpleWSMMod();
        CoreExport virtual ~SimpleWSMMod();

        ChannelMask ChannelsUsed()  { return PART_GEOM|PART_TOPO; }
        ChannelMask ChannelsChanged() { return PART_GEOM; }
        CoreExport void ModifyObject(TimeValue t, ModContext &mc, ObjectState *os, INode *node);
        Class_ID InputType() {return defObjectClassID;}
        CoreExport Interval LocalValidity(TimeValue t);     
        BOOL ChangeTopology() {return FALSE;}
        CreateMouseCallBack* GetCreateMouseCallBack() {return NULL;}

        int NumRefs() {return 3;}
        CoreExport RefTargetHandle GetReference(int i);
protected:
        CoreExport virtual void SetReference(int i, RefTargetHandle rtarg);
public:

        int NumSubs() {return 1;}
        CoreExport Animatable* SubAnim(int i);
        CoreExport MSTR SubAnimName(int i);

        CoreExport RefResult NotifyRefChanged( Interval changeInt,RefTargetHandle hTarget, 
           PartID& partID, RefMessage message);
        
        CoreExport IParamArray *GetParamBlock();
        CoreExport int GetParamBlockIndex(int id);

        // Evaluates the node reference and returns the WSM object.
        CoreExport WSMObject *GetWSMObject(TimeValue t);
                
        // When clients are cloning themselves, they should call this 
        // method on the clone to copy SimpleMod's data.
        // NOTE: DEPRECATED! Use SimpleWSMModClone(SimpleMod *smodSource, RemapDir& remap )
        CoreExport void SimpleWSMModClone(SimpleWSMMod *smodSource);

        // When clients are cloning themselves, they should call this 
        // method on the clone to copy SimpleMod's data.
        CoreExport void SimpleWSMModClone(SimpleWSMMod *smodSource, RemapDir& remap);

        // Clients of simpmod probably want to override these. If they do
        // the should call these from within thier methods.
        CoreExport void BeginEditParams(IObjParam *ip, ULONG flags,Animatable *prev);
        CoreExport void EndEditParams(IObjParam *ip, ULONG flags,Animatable *next);

        // Clients of simpmod need to implement this method
        virtual Deformer& GetDeformer(TimeValue t,ModContext &mc,Matrix3& mat,Matrix3& invmat)=0;
        virtual void InvalidateUI() {}
        virtual Interval GetValidity(TimeValue t) {return FOREVER;}
        virtual ParamDimension *GetParameterDim(int pbIndex) {return defaultDim;}
        virtual MSTR GetParameterName(int pbIndex) {return MSTR(_M("Parameter"));}
        #pragma warning(pop)
        virtual void InvalidateParamMap() {}

        // Schematic view Animatable overides...
        CoreExport SvGraphNodeReference SvTraverseAnimGraph(IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags);
    };

// CAL-01/10/02: ParamBlock2 specialization (replaces a IParamBlock with IParamBlock2 block pointer)
class SimpleWSMMod2 : public SimpleWSMMod {
    public:
        IParamBlock2* pblock2;

        SimpleWSMMod2() { pblock2 = NULL; }
        
        // From Animatable
        Animatable* SubAnim(int i);

        // From ReferenceMaker
        RefTargetHandle GetReference(int i);
protected:
        virtual void SetReference(int i, RefTargetHandle rtarg);
public:

        // From BaseObject
        // IParamArray *GetParamBlock() { return NULL; }
        // int GetParamBlockIndex(int id) { return -1; }

        // From SimpleWSMMod
        // NOTE: DEPRECATED! Use SimpleWSMModClone(SimpleMod *smodSource, RemapDir& remap )
        void SimpleWSMModClone(SimpleWSMMod2 *smodSource);

        // From SimpleWSMMod
        void SimpleWSMModClone(SimpleWSMMod2 *smodSource, RemapDir& remap);
    };


#define SIMPWSMMOD_OBREF        0
#define SIMPWSMMOD_NODEREF      1
#define SIMPWSMMOD_PBLOCKREF    2

#define SIMPLEOSMTOWSM_CLASSID  Class_ID(0x3fa72be3,0xa5ee1bf9)

#pragma warning(push)
#pragma warning(disable:4239)

// Used by SimpleOSMToWSMObject to create WSMs out of OSMs
class SimpleOSMToWSMMod : public SimpleWSMMod {
    public:
        CoreExport SimpleOSMToWSMMod();
        CoreExport SimpleOSMToWSMMod(INode *node);

        void GetClassName(MSTR& s) {s=GetObjectName();}
        SClass_ID SuperClassID() {return WSM_CLASS_ID;}
        Class_ID ClassID() {return SIMPLEOSMTOWSM_CLASSID;} 
        CoreExport void DeleteThis();
        
        CoreExport RefTargetHandle Clone(RemapDir& remap);
        CoreExport MCHAR *GetObjectName();

        CoreExport Deformer& GetDeformer(TimeValue t,ModContext &mc,Matrix3& mat,Matrix3& invmat);      
        CoreExport Interval GetValidity(TimeValue t);       
    };

// CAL-01/10/02: ParamBlock2 specialization (replaces a IParamBlock with IParamBlock2 block pointer)
#define SIMPLEOSMTOWSM2_CLASSID Class_ID(0x385220f9, 0x7e7f48e9)

class SimpleOSMToWSMMod2 : public SimpleWSMMod2 {
    public:
        CoreExport SimpleOSMToWSMMod2();
        CoreExport SimpleOSMToWSMMod2(INode *node);

        void GetClassName(MSTR& s) {s=GetObjectName();}
        SClass_ID SuperClassID() {return WSM_CLASS_ID;}
        Class_ID ClassID() {return SIMPLEOSMTOWSM2_CLASSID;} 
        CoreExport void DeleteThis();
        CoreExport RefTargetHandle Clone(RemapDir& remap);
        CoreExport MCHAR *GetObjectName();

        CoreExport Deformer& GetDeformer(TimeValue t,ModContext &mc,Matrix3& mat,Matrix3& invmat);      
        CoreExport Interval GetValidity(TimeValue t);       
    };
#pragma warning(pop)
CoreExport ClassDesc* GetSimpleOSMToWSMModDesc();
CoreExport ClassDesc* GetSimpleOSMToWSMMod2Desc();