Public TypePublic FunctionsType enum
Values:
- NoAutosave = 0x010000 -
- Readonly = 0x020000 -
- In = 0x040000 -
- Out = 0x080000 -
- Pointer = 0x000001 -
- Char = 0x000002 -
- Int = 0x000004 -
- Double = 0x000008 -
- String = 0x000020 | Pointer -
- HWRef = 0x000040 | Pointer | NoAutosave -
- DObjPtr = 0x000010 | Pointer | NoAutosave -
- CharArray = Char | Pointer -
- IntArray = Int | Pointer -
- DoubleArray = Double | Pointer -
- PointCloudPtr = 0x000080 | Pointer | NoAutosave -
- PointPtr = 0x000100 | Pointer | NoAutosave -
- PolygonMeshPtr = 0x000200 | Pointer | NoAutosave -
Public Static FunctonsParamBase()default constructor, creates “empty” tParam
ParamBase(const char * name)ParamBase(const char * name, const uint32 type)ParamBase(const char * name, const uint32 type, const char * val)constructor with name and type, char val and optional info creates a new ParamBase with name, type, string value. Strings are copied
ParamBase(const char * name, const uint32 type, const double val)ParamBase(const char * name, const uint32 type, const int val)ParamBase(const ByteArray & name, const uint32 type, const char * val)constructor with name and type, char val and optional info creates a new ParamBase with name, type, string value. Strings are copied
ParamBase(const ByteArray & name, const uint32 type, const double val)ParamBase(const ByteArray & name, const uint32 type, const int val)ParamBase(const char * name, const uint32 type, const unsigned int size, const char * values)array constructor with name and type, size and array creates a new ParamBase (array) with name, type, size and values.
ParamBase(const char * name, const uint32 type, const unsigned int size, const int * values)array constructor with name and type, size and array creates a new ParamBase (array) with name, type, size and values.
ParamBase(const char * name, const uint32 type, const unsigned int size, const double * values)array constructor with name and type, size and array creates a new ParamBase (array) with name, type, size and values.
~ParamBase()destructor
clear (frees) the name and in case a string value.
ParamBase(const ParamBase & copyConstr)const ParamBase operator[](const int num)braces operator for element-wise access in arrays
braces operator returns the value of the index num from the array
- Return
- new tParam with values of ParamBase[num] in the array
- Parameters
- num -
array index for which the value should be returned
ito::RetVal copyValueFrom(const ito::ParamBase * rhs)just copies the value from the right-hand-side tParam (rhs) to this tParam.
bool isNumeric(void)returns true if Param is of type char, int or double
ito::RetVal addNameSuffix(const char * suffix)bool isValid(void)returns whether tParam contains a valid type (true) or is an empty parameter (false, type == 0). The default tParam-constructor is always an invalid tParam.
uint32 getType(bool filterFlags = true)returns parameter type (autosave flag and optional flag are only included if filterFlags is set false)
uint32 getFlags(void)returns parameter flags (parameter type is not included)
uint32 setFlags(const uint32 flags)sets parameter flags (parameter type remains untouched), for possible flags see tParamType
const char * getName(void)returns parameter name (string is not copid)
uint32 getAutosave(void)returns content of autosave flag - this flag determines whether the parameter value gets automagically saved to xml file when an instance of a plugin class is deleted (closed)
void setAutosave(const uint32 autosave)sets content of autosave flag - this flag determines whether the parameter value gets automagically saved to xml file when an instance of a plugin class is deleted (closed)
int getLen(void)template < typename _Tp >ito::RetVal setVal(_Tp val)setVal set parameter value - templated version
- Return
- RetVal with operation status sets the parameter value to the passed value, if the parameter type is inadequate it is set to the maximum value of template type
- Parameters
- val -
value to set to
template < typename _Tp >ito::RetVal setVal(_Tp val, int len)setVal set parameter value - templated version for arrays
- Return
- RetVal with operation status sets the parameter value to the passed value, if the length is below 1 or a Null pointer is passed an error is returned
- Parameters
- val -
value to set to
- len -
length of array
template < typename _Tp >_Tp getVal(void)getVal read parameter value - templated version returns the actual parameter value casted to the template parameter type. If the tParam has a non numeric type the largest value for the template type is passed.
- Return
- parameter value (numeric, casted)
template < typename _Tp >_Tp getVal(int & len)getVal read parameter value - templated version for arrays returns the actual parameter value casted to the template parameter type. In ‘len’ is returned what is supposed to be the length of the array. As only array references are used within tParam the actual size may differ.
- Parameters
- len -
length of array
uint32 typeFilter(uint32 type)