CWE-ou-minkata/Sources/Tools/MaxComponent/plDistribComponent.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/

#ifndef plDistribComponent_inc
#define plDistribComponent_inc

const Class_ID DISTRIBUTOR_COMP_CID(0x78143984, 0x3e7c78ec);

#include "MaxConvert/plDistributor.h"

class plMaxNode;
class plDistributor;
class plDistribInstTab;
class plExportProgressBar;
class plDistTree;

//Class that accesses the paramblock below.
class plDistribComponent : public plComponent
{
public:
    enum 
    {
        kRollTemplates,
        kRollSpacing,
        kRollScale,
        kRollOrient,
        kRollAngProb,
        kRollAltProb,
        kRollConform,
        kRollBitmap,
        kRollFade,
        kRollWind,
        kRollRandomize,
        kRollAction,

        kNumRollups
    };
    enum 
    {
        kTemplates = 0,

        // Spacing
        kSpacing,
        kSpaceRnd,
        kDensity,
        kSeparation,

        // Scale
        kScaleLoX,
        kScaleLoY,
        kScaleLoZ,

        kScaleHiX,
        kScaleHiY,
        kScaleHiZ,

        kLockScaleXY,
        kLockScaleXYZ,

        // Orient
        kAlignWgt,
        kPolarRange,
        kAzimuthRange,      
        
        kPolarBunch,
        
        // Angle prob
        kAngProbHi,
        kAngProbLo,
        kAngProbTrans,

        // Altitude prob
        kAltProbHi,
        kAltProbLo,
        kAltProbTrans,

        // Surface Conformity
        kConformType,
        kConformMax,
        kOffsetMin,
        kOffsetMax,

        // Bitmap
        kProbTexmap,
        kProbColorChan,

        kRemapFromLo,
        kRemapFromHi,
        kRemapToLo,
        kRemapToHi,

        // Fade
        kFadeInTran,
        kFadeInOpaq,
        kFadeOutTran,
        kFadeOutOpaq,
        kFadeInActive,

        // Wind
        kWindBone,
        kWindBoneActive,

        // Randomization
        kSeedLocked,
        kSeed,
        kNextSeed,

        // Etc.
        kReplicants,
        kRollupState,

        kFaceNormals,

        kNumParams

    };

    plMeshCacheTab      fDistCache;

    void        ISetProbTexmap(plDistributor& distrib);
    INode*      IMakeOne(plDistribInstTab& nodes);

    BOOL        IValidateFade(Box3& fade);

public:
    plDistribComponent();
    void DeleteThis() { delete this; }


    BOOL            Distribute(plDistribInstTab& reps, plErrorMsg* pErrMsg, plExportProgressBar& bar, plDistTree* dt=nil);
    void            Done();

    void            Clear();
    void            Preview();

    // See notes below
    Box3            GetFade();
    BOOL            IsFlexible() const;
    float           GetIsoPriority() const;

    plDistributor::IsoType GetIsolation() const;
    plDistributor::ColorChan GetProbabilityChan() const;
    plDistributor::ConformType GetConformity() const;

    // SetupProperties - Internal setup and write-only set properties on the MaxNode. No reading
    // of properties on the MaxNode, as it's still indeterminant.
    virtual hsBool SetupProperties(plMaxNode *node, plErrorMsg *pErrMsg);
    virtual hsBool PreConvert(plMaxNode *node, plErrorMsg *pErrMsg)     { return true; }
    virtual hsBool Convert(plMaxNode *node, plErrorMsg *pErrMsg) { return true; }
};


    // GetFade() notes.
    // Fade returned as follows:
    // Box3.Min()[0] == fadeInTransparent
    // Box3.Min()[1] == fadeInOpaque
    // Box3.Max()[0] == fadeOutTransparent
    // Box3.Max()[1] == fadeOutOpaque
    //
    // Box3.Min()[2] == 0 turns off fadein.
    // Box3.Max()[2] == 0 turns off fadeout.
    // 
    // In all cases, max(Min()[0],Min()[1]) <= min(Max()[0], Max()[1])
    //
    // Also, either Min()[0] <= Min()[1] && Max()[0] >= Max()[1]
    //          or Min()[0] >= Min()[1] && Max()[0] <= Max()[1]
    // that is, we either start transparent, go to opaque and back to transparent,
    //              or we start opaque, go transparent, and back to opaque.
    // Makes sense if you think about it.
    //
    // If Min()[0] == Min()[1], there is no fade in, we start transparent or opaque
    //      as determined by Max()[0] and Max()[1].
    // Same for equal Maxs.
    // Naturally, Min()[0] == Min()[1] && Max()[0] == Max()[1] turns the whole thing off.
    //
    // Also, as a convenience, if the transparent distance is less than the opaque distance
    // (signifying a fade out), then the Z component will be -1, else if it's off, zero, else 1.
    // In Summario:
    //  if( box.Min()[0] < box.Min()[1] ) // Transparent less than Opaque
    //      box.Min()[2] = -1.f;
    //  else if( box.Min()[0] == box.Min()[1] ) // Tran same as Opaque, disabled
    //      box.Min()[2] = 0;
    //  else                                // Leaves Opaque less than Transparent.
    //      box.Min()[2] = 1.f;

#endif // plDistribComponent_inc