nel/tools/3d/object_viewer/attrib_dlg.h

   1 // NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #if !defined(AFX_ATTRIB_DLG_H__DF35743E_C8B4_4218_9C42_A3DF4126BEF2__INCLUDED_)
  18 #define AFX_ATTRIB_DLG_H__DF35743E_C8B4_4218_9C42_A3DF4126BEF2__INCLUDED_
  19
  20 #if _MSC_VER > 1000
  21 #pragma once
  22 #endif
  23
  24
  25 #include "nel/misc/rgba.h"
  26 #include "nel/3d/ps_plane_basis.h"
  27 #include "nel/3d/ps_attrib_maker.h"
  28 #include "editable_range.h"
  29 #include "popup_notify.h"
  30 #include "particle_workspace.h"
  31
  32 namespace NL3D
  33 {
  34         class CPSAttribMakerBase;
  35 }
  36
  37 using NLMISC::CRGBA;
  38
  39
  40
  41 class CEditAttribDlg;
  42
  43
  44 /////////////////////////////////////////////////////////////////////////////
  45 // CAttribDlg dialog
  46
  47 class CAttribDlg : public CDialog, public IPopupNotify
  48 {
  49 // Construction
  50 public:
  51         /** construct the dialog
  52           * \param : valueID : an unique id for this dialog
  53           * \param : enableConstantValue when false, only a scheme is available
  54           */
  55         CAttribDlg(const std::string &valueID, CParticleWorkspace::CNode *ownerNode, bool enableConstantValue = true);   // standard constructor
  56         CAttribDlg::~CAttribDlg();
  57
  58
  59         /// must be called before init, disable constant value usage
  60         void disableConstantValue(void) { _EnableConstantValue = false; }
  61
  62         // close window if being edited
  63         void closeEditWindow();
  64
  65 // Dialog Data
  66         //{{AFX_DATA(CAttribDlg)
  67         enum { IDD = IDD_ATTRIB_DLG };
  68         CButton m_PutScheme;
  69         CButton m_GetScheme;
  70         CButton m_EditUserParam;
  71         CComboBox       m_SchemeInput;
  72         CStatic m_CstValuePos;
  73         CStatic m_NbCyclePos;
  74         CButton m_AttrBitmap;
  75         CButton m_ClampCtrl;
  76         CButton m_EditScheme;
  77         CComboBox       m_UseScheme;
  78         CComboBox       m_Scheme;
  79         CString m_AttribName;
  80         BOOL    m_Clamp;
  81         //}}AFX_DATA
  82
  83
  84         /// init the dialog with the given bitmap
  85         void init(HBITMAP bitmap, sint x, sint y, CWnd *pParent = NULL);
  86
  87         // force to update dialog content
  88         void update();
  89
  90 // Overrides
  91         // ClassWizard generated virtual function overrides
  92         //{{AFX_VIRTUAL(CAttribDlg)
  93         protected:
  94         virtual void DoDataExchange(CDataExchange* pDX);    // DDX/DDV support
  95         //}}AFX_VIRTUAL
  96
  97 public:
  98
  99         /// enable the srcInput
 100         void enableSrcInput(bool enable = true) { _SrcInputEnabled = enable; }
 101         bool isSrcInputEnabled() const { return _SrcInputEnabled; }
 102
 103
 104         /** Disable the possibility to choose a scheme that has memory. (for example, a scheme for lifetime of a located has no sense
 105           * because located have already some memory to store it)
 106           */
 107         void enableMemoryScheme(bool enabled = true) { _DisableMemoryScheme = !enabled; }
 108
 109         /** tells whether memory schemes are enables
 110           * \see enableMemoryScheme()
 111           */
 112         bool isMemorySchemeEnabled() const { return !_DisableMemoryScheme; }
 113
 114         /// enable Nb Cycle tuning
 115         void    enableNbCycles(bool enabled = true) { _NbCycleEnabled = enabled; }
 116         bool    isNbCycleEnabled() const { return _NbCycleEnabled; }
 117
 118
 119 public:
 120         // private usage (not private because accessed by a static function) : return the nbCycles parameter of the scheme (e.g the input multiplier).
 121         virtual float getSchemeNbCycles(void) const = 0;
 122
 123         // private usage (not private because accessed by a static function) : set the nbCycles parameter of the scheme (e.g the input multiplier)
 124         virtual void setSchemeNbCycles(float nbCycles) = 0;
 125
 126         BOOL EnableWindow( BOOL bEnable = TRUE );
 127
 128 // Implementation
 129 protected:
 130
 131         /// bool : true is src input are allowed
 132         bool _SrcInputEnabled;
 133
 134         // true if constant values are allowed
 135         bool _EnableConstantValue;
 136
 137         // change the dialog for constant values
 138         void cstValueUpdate();
 139
 140         /// enable / disable the 'edit input' button, when input can be edited
 141         void inputValueUpdate(void);
 142
 143
 144         // toggle back from scheme to cst value
 145         virtual void resetCstValue(void) = 0;
 146
 147         // change the dialog for scheme usage
 148         void schemeValueUpdate();
 149
 150         // return true if a scheme is used
 151         virtual bool useScheme(void) const = 0;
 152
 153
 154         // get the number of attributes makers  (schemes) that are available
 155         virtual uint getNumScheme(void) const = 0;
 156
 157         // get the text associated with an attribute maker
 158         virtual std::string getSchemeName(uint index) const = 0;
 159
 160         // edit the current scheme. And return a window on it
 161         virtual CWnd *editScheme(void) = 0;
 162
 163         // set the current scheme
 164         virtual void setCurrentScheme(uint index) = 0;
 165
 166         // set the current scheme ptr
 167         virtual void setCurrentSchemePtr(NL3D::CPSAttribMakerBase *) = 0;
 168
 169         // get the current scheme, -1 if the scheme is unknow (created outside the editor ?)
 170         virtual sint getCurrentScheme(void) const = 0;
 171
 172         /// get a pointer on the current scheme base class
 173         virtual NL3D::CPSAttribMakerBase *getCurrentSchemePtr(void) const = 0;
 174
 175
 176         // this must return the right dialog for a constant value (created with nex)
 177         virtual CEditAttribDlg *createConstantValueDlg() = 0;
 178
 179
 180         // tells whether the scheme supports custom input
 181         virtual bool hasSchemeCustomInput(void) const = 0;
 182         // retrieve the scheme input id
 183         virtual NL3D::CPSInputType getSchemeInput(void) const = 0;
 184         // set the scheme input id
 185         virtual void setSchemeInput(const NL3D::CPSInputType &input) = 0;
 186
 187         // tells whether the scheme input value is clamped or not
 188         virtual bool isSchemeClamped(void) const = 0;
 189         // clamp / unclamp the scheme
 190         virtual void clampScheme(bool clamped = true) = 0;
 191         // return true if clamping is supported
 192         virtual bool isClampingSupported(void) const = 0;
 193
 194         /// inherited from IPopupNotify
 195         virtual void childPopupClosed(CWnd *child);
 196
 197
 198         // the dialog used to tune the nb cycles param (when available)
 199         CEditableRangeFloat *_NbCyclesDlg;
 200         // this is equal to true when memory schemes are not permitted
 201         bool _DisableMemoryScheme;
 202         /// true to enable 'nb cycles' control
 203         bool _NbCycleEnabled;
 204         // wrapper to tune the number of cycles
 205         struct CNbCyclesWrapper : public IPSWrapperFloat
 206         {
 207                         CAttribDlg *Dlg;
 208                         float get(void) const { return Dlg->getSchemeNbCycles(); }
 209                         void set(const float &v) { Dlg->setSchemeNbCycles(v); }
 210         } _NbCyclesWrapper;
 211         // true when created, it is set to false once a constant, or scheme dialog has bee shown
 212         bool _FirstDrawing;
 213         // the dialog used to tune a constant value
 214         CEditAttribDlg *_CstValueDlg;
 215
 216         // the current dialog for scheme edition
 217         CWnd               *_SchemeEditionDlg;
 218         std::string             _ValueID;
 219         CParticleWorkspace::CNode *_Node;
 220
 221         // Generated message map functions
 222         //{{AFX_MSG(CAttribDlg)
 223         afx_msg void OnSelchangeUseScheme();
 224         afx_msg void OnSelchangeScheme();
 225         afx_msg void OnEditScheme();
 226         afx_msg void OnSelchangeSchemeInput();
 227         afx_msg void OnClampAttrib();
 228         afx_msg void OnEditInput();
 229         afx_msg void OnGetScheme();
 230         afx_msg void OnPutScheme();
 231         afx_msg void OnDestroy();
 232         afx_msg void OnClose();
 233         //}}AFX_MSG
 234         DECLARE_MESSAGE_MAP()
 235 };
 236
 237
 238
 239
 240
 241
 242
 243
 244 /**
 245  * a template class that helps to specialize the attrib maker edition dialog with various types
 246  */
 247 template <typename T> class CAttribDlgT : public CAttribDlg
 248 {
 249 public:
 250         CAttribDlgT(const std::string &valueID, CParticleWorkspace::CNode *node) : CAttribDlg(valueID, node),
 251                                                                                                                                                            _Wrapper(NULL),
 252                                                                                                                                                            _SchemeWrapper(NULL)
 253         {
 254         }
 255         void setWrapper(IPSWrapper<T> *wrapper) { nlassert(wrapper); _Wrapper = wrapper; _Wrapper->OwnerNode = _Node; }
 256         void setSchemeWrapper(IPSSchemeWrapper<T> *schemeWrapper) { nlassert(schemeWrapper); _SchemeWrapper = schemeWrapper; _SchemeWrapper->OwnerNode = _Node; }
 257
 258         // inherited from CAttribDlg
 259         virtual uint getNumScheme(void) const = 0;
 260         virtual std::string getSchemeName(uint index) const = 0;
 261         virtual CWnd *editScheme(void) = 0;
 262         virtual void setCurrentScheme(uint index) = 0;
 263         virtual sint getCurrentScheme(void) const  = 0;
 264
 265         virtual void resetCstValue(void)
 266         {
 267                 _Wrapper->setAndUpdateModifiedFlag(_Wrapper->get()); // reuse current color
 268         }
 269
 270         virtual bool hasSchemeCustomInput(void) const { return _SchemeWrapper->getScheme()->hasCustomInput(); }
 271         virtual NL3D::CPSInputType getSchemeInput(void) const { return  _SchemeWrapper->getScheme()->getInput(); }
 272         virtual void setSchemeInput(const NL3D::CPSInputType &input) { _SchemeWrapper->getScheme()->setInput(input); }
 273
 274
 275         virtual float getSchemeNbCycles(void) const { return _SchemeWrapper->getScheme()->getNbCycles(); }
 276         virtual void setSchemeNbCycles(float nbCycles) { _SchemeWrapper->getScheme()->setNbCycles(nbCycles); }
 277
 278
 279
 280         virtual bool isSchemeClamped(void) const { return _SchemeWrapper->getScheme()->getClamping(); }
 281         virtual void clampScheme(bool clamped = true) { _SchemeWrapper->getScheme()->setClamping(clamped); }
 282         virtual bool isClampingSupported(void) const { return _SchemeWrapper->getScheme()->isClampingSupported(); };
 283         virtual NL3D::CPSAttribMakerBase *getCurrentSchemePtr(void) const { return _SchemeWrapper->getScheme(); }
 284         virtual void setCurrentSchemePtr(NL3D::CPSAttribMakerBase *s)
 285         {
 286                 _SchemeWrapper->setSchemeAndUpdateModifiedFlag(NLMISC::safe_cast<NL3D::CPSAttribMaker<T> *>(s));
 287         }
 288
 289
 290 protected:
 291         virtual bool useScheme(void) const
 292         {
 293                 nlassert(_SchemeWrapper);
 294                 return(_SchemeWrapper->getScheme() != NULL);
 295         }
 296 public:
 297         // wrapper to set/get a constant float
 298         IPSWrapper<T> *_Wrapper;
 299         // wrapper to set/get a scheme
 300         IPSSchemeWrapper<T> *_SchemeWrapper     ;
 301 };
 302
 303 /** an attribute editor specialized for float values
 304  */
 305
 306 class CAttribDlgFloat : public CAttribDlgT<float>, public CBoundCheckerFloat
 307 {
 308 public:
 309         /** ctor
 310          *  \param valueID an unique id for the constant value editable range dialog
 311          *  \param minValue : the min value for the editable range dlg(for constant value)
 312          *  \param maxValue : the min value for the editable range dlg (for constant value)
 313          */
 314         CAttribDlgFloat(const std::string &valueID, CParticleWorkspace::CNode *node, float minValue = 0, float maxValue = 10);
 315
 316
 317         // inherited from CAttribDlg
 318         virtual uint getNumScheme(void) const;
 319         virtual std::string getSchemeName(uint index) const;
 320         virtual CWnd *editScheme(void);
 321         virtual void setCurrentScheme(uint index);
 322         virtual sint getCurrentScheme(void) const;
 323
 324
 325
 326 protected:
 327
 328         virtual CEditAttribDlg *createConstantValueDlg();
 329         // ID for the cst float value  edition dialog
 330         std::string _CstValueId;
 331         float _MinRange, _MaxRange;
 332 };
 333
 334
 335 /** an attribute editor specialized for unsigned int values
 336  */
 337
 338 class CAttribDlgUInt : public CAttribDlgT<uint32>, public CBoundCheckerUInt
 339 {
 340 public:
 341         /** ctor
 342          *  \param valueID an unique id for the constant value editable range dialog
 343          *  \param minValue : the min value for the editable range dlg(for constant value)
 344          *  \param maxValue : the min value for the editable range dlg (for constant value)
 345          */
 346         CAttribDlgUInt(const std::string &valueID, CParticleWorkspace::CNode *node, uint32 minValue = 0, uint32 maxValue = 10);
 347
 348
 349         // inherited from CAttribDlg
 350         virtual uint getNumScheme(void) const;
 351         virtual std::string getSchemeName(uint index) const;
 352         virtual CWnd *editScheme(void);
 353         virtual void setCurrentScheme(uint index);
 354         virtual sint getCurrentScheme(void) const;
 355
 356
 357
 358 protected:
 359
 360         virtual CEditAttribDlg *createConstantValueDlg();
 361         // ID for the cst float value  edition dialog
 362         std::string _CstValueId;
 363         uint32 _MinRange, _MaxRange;
 364 };
 365
 366
 367
 368 /** an attribute editor specialized for signed int values
 369  */
 370
 371 class CAttribDlgInt : public CAttribDlgT<sint32>, public CBoundCheckerInt
 372 {
 373 public:
 374         /** ctor
 375          *  \param valueID an unique id for the constant value editable range dialog
 376          *  \param minValue : the min value for the editable range dlg(for constant value)
 377          *  \param maxValue : the min value for the editable range dlg (for constant value)
 378          */
 379         CAttribDlgInt(const std::string &valueID, CParticleWorkspace::CNode *node, sint32 minValue = 0, sint32 maxValue = 10);
 380
 381
 382         // inherited from CAttribDlg
 383         virtual uint getNumScheme(void) const;
 384         virtual std::string getSchemeName(uint index) const;
 385         virtual CWnd *editScheme(void);
 386         virtual void setCurrentScheme(uint index);
 387         virtual sint getCurrentScheme(void) const;
 388
 389
 390
 391 protected:
 392
 393         virtual CEditAttribDlg *createConstantValueDlg();
 394         // ID for the cst float value  edition dialog
 395         std::string _CstValueId;
 396         sint32 _MinRange, _MaxRange;
 397 };
 398
 399
 400
 401
 402 /** an attribute editor specialized for RGB values
 403  */
 404
 405 class CAttribDlgRGBA : public CAttribDlgT<CRGBA>
 406 {
 407 public:
 408         /** ctor
 409          *  \param valueID an unique id for the constant value editable range dialog
 410          */
 411         CAttribDlgRGBA(const std::string &valueID, CParticleWorkspace::CNode *node);
 412
 413
 414         // inherited from CAttribDlg
 415         virtual uint getNumScheme(void) const;
 416         virtual std::string getSchemeName(uint index) const;
 417         virtual CWnd *editScheme(void);
 418         virtual void setCurrentScheme(uint index);
 419         virtual sint getCurrentScheme(void) const;
 420
 421
 422
 423 protected:
 424
 425         virtual CEditAttribDlg *createConstantValueDlg();
 426         // ID for the cst float value  edition dialog
 427         std::string _CstValueId;
 428 };
 429
 430
 431 /** an attribute editor specialized for plane basis values
 432  */
 433
 434 class CAttribDlgPlaneBasis : public CAttribDlgT<NL3D::CPlaneBasis>
 435 {
 436 public:
 437         /** ctor
 438          *  \param valueID an unique id for the constant value editable range dialog
 439          */
 440         CAttribDlgPlaneBasis(const std::string &valueID, CParticleWorkspace::CNode *node);
 441
 442
 443         // inherited from CAttribDlg
 444         virtual uint getNumScheme(void) const;
 445         virtual std::string getSchemeName(uint index) const;
 446         virtual CWnd *editScheme(void);
 447         virtual void setCurrentScheme(uint index);
 448         virtual sint getCurrentScheme(void) const;
 449
 450
 451
 452 protected:
 453
 454         virtual CEditAttribDlg *createConstantValueDlg();
 455         // ID for the cst float value  edition dialog
 456         std::string _CstValueId;
 457 };
 458
 459
 460
 461 //{{AFX_INSERT_LOCATION}}
 462 // Microsoft Visual C++ will insert additional declarations immediately before the previous line.
 463
 464 #endif // !defined(AFX_ATTRIB_DLG_H__DF35743E_C8B4_4218_9C42_A3DF4126BEF2__INCLUDED_)