MultiplyInt.cpp

Demonstrates creation of a VObject and how to create parameters and do some computation with these parameter values. This a very basic tutorial. A good point to start from.

Use it to mulitply an integer by a given integer. Connect it to any other int input parameter of other VObjects.

Start e.g.: ../../../bin/vish MultiplyInt.vis

See also:

Further tutorials: - Simple3DObject.cpp

#include <ocean/plankton/VModules.hpp>
#include <ocean/plankton/VCreator.hpp>

// an empty macro to make code more readable
#define override

using namespace Wizt;


class MultiplyInt : public Wizt::VObject
{
  // define input and output Parameters of the VObject  
  TypedSlot<int> IntInParam;
  TypedSlot<int> Multiplier;
  VOutput<int> IntOutParam;

public:
  MultiplyInt(const string&name, int p, const RefPtr<VCreationPreferences>&VP)
  : VObject(name, p, VP)
    // Set the name of the parameter (seen in the GUI and used as name in the script language)
    // and the default value. Initialisation must be done in the same order as declarations.
    // An additional value calles 'expert level' may be set to hide same parameters to certain
    // expert levels. Use the slider 'EL' provided in 'Properties' of a module to control the 
    // expert level. (right click on module's name)
    , IntInParam(this, "intinput", 0, 5)
    , IntOutParam(self(), "intoutput", 1)
    , Multiplier( this, "multiplier", 2 )
  {
          // Set a maximum value for the parameter slider.
          Multiplier.setProperty("max", 8);
  }
  
  // The update function is the heart of the VObject. All functionality of the VObject is 
  // provided inside the update function. All data is handled through the VRequest. The precision
  // value is internally used to estimate the time the update function evaluation takes. In 
  // certain casese an update function call may be skipped if it has a long precision. 
  override bool update(VRequest&R, double precision)
  {
    int x = 0;
    int m = 0;
    
    // Get the Value of the IntInParam and Multiplier of actual context.
    IntInParam << R >> x; 
    Multiplier << R >> m;
    
    // Calculate new Value.
    x *= m;
    
    // Out value into IntOutParam at actual context.
    IntOutParam << R << x;

    return true;
  }
                                                                  
  
};
      

// create one creator object VCreator for MultiplyInt and specify where it should be placed in the creation menu ('examples/..')
static Ref< VCreator<MultiplyInt, AcceptList<int> > > VMultiplyIntCreator("Tutorial/MultiplyInt");

// callback that ensures global constructors are really called
VISH_DEFAULT_INIT

---