From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a02551.html | 3183 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 3183 insertions(+) create mode 100644 docs/doxygen/nel/a02551.html (limited to 'docs/doxygen/nel/a02551.html') diff --git a/docs/doxygen/nel/a02551.html b/docs/doxygen/nel/a02551.html new file mode 100644 index 00000000..816fd553 --- /dev/null +++ b/docs/doxygen/nel/a02551.html @@ -0,0 +1,3183 @@ + + +NeL: NLGEORGES::UFormElm class Reference + + + +
+Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 
+

NLGEORGES::UFormElm Class Reference

#include <u_form_elm.h> +

+

Inheritance diagram for NLGEORGES::UFormElm: +

+ +NLGEORGES::CFormElm +NLGEORGES::CFormElmArray +NLGEORGES::CFormElmAtom +NLGEORGES::CFormElmStruct +NLGEORGES::CFormElmVirtualStruct + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types

enum  TEval { NoEval, +Formula, +Eval + }
 Value evalution. More...

enum  TWhereIsNode { NodeForm, +NodeParentForm, +NodeDfn, +NodeType + }
 Where a node has been found. More...

enum  TWhereIsValue {
+  ValueForm, +ValueParentForm, +ValueDefaultDfn, +ValueDefaultType, +
+  Dummy = 0xffffffff +
+ }
 Where a value has been found. More...


Public Member Functions

virtual bool getArrayNode (UFormElm **result, uint arrayIndex)=0
virtual bool getArrayNode (const UFormElm **result, uint arrayIndex) const=0
virtual bool getArrayNodeName (std::string &result, uint arrayIndex) const=0
 Return the name of a table element.

virtual bool getArraySize (uint &size) const=0
 Return true if the element is an array and fill size with the array size.

virtual bool getArrayValue (NLMISC::CRGBA &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
 Warning, only R, G and B members are filled, not A.

virtual bool getArrayValue (bool &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (double &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (float &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (uint32 &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (sint32 &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (uint16 &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (sint16 &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (uint8 &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (sint8 &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getArrayValue (std::string &result, uint arrayIndex, TEval evaluate=Eval, TWhereIsValue *where=NULL) const=0
virtual bool getDfnName (std::string &dfnName) const=0
 Get the dfn filename for this virtual struct. Must be a virtual struct node.

virtual bool getNodeByName (UFormElm **result, const char *name, TWhereIsNode *where=NULL, bool reserved=true, uint32 round=0)=0
virtual bool getNodeByName (const UFormElm **result, const char *name, TWhereIsNode *where=NULL, bool reserved=true, uint32 round=0) const=0
virtual class UFormDfn * getStructDfn ()=0
 Return the struct dfn.

virtual bool getStructNode (uint element, UFormElm **result)=0
 Return a mutable element pointer. Can be NULL if the node doesn't exist.

virtual bool getStructNode (uint element, const UFormElm **result) const=0
 Return a const element pointer. Can be NULL if the node doesn't exist.

virtual bool getStructNodeName (uint element, std::string &result) const=0
 Return the element name.

virtual bool getStructSize (uint &size) const=0
 Return the struct size.

virtual bool getValue (NLMISC::CRGBA &result, TEval evaluate=Eval) const=0
 Warning, only R, G and B members are filled, not A.

virtual bool getValue (bool &result, TEval evaluate=Eval) const=0
virtual bool getValue (double &result, TEval evaluate=Eval) const=0
virtual bool getValue (float &result, TEval evaluate=Eval) const=0
virtual bool getValue (uint32 &result, TEval evaluate=Eval) const=0
virtual bool getValue (sint32 &result, TEval evaluate=Eval) const=0
virtual bool getValue (uint16 &result, TEval evaluate=Eval) const=0
virtual bool getValue (sint16 &result, TEval evaluate=Eval) const=0
virtual bool getValue (uint8 &result, TEval evaluate=Eval) const=0
virtual bool getValue (sint8 &result, TEval evaluate=Eval) const=0
virtual bool getValue (std::string &result, TEval evaluate=Eval) const=0
virtual bool getValueByName (NLMISC::CRGBA &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
 Warning, only R, G and B members are filled, not A.

virtual bool getValueByName (bool &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (double &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (float &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (uint32 &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (sint32 &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (uint16 &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (sint16 &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (uint8 &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (sint8 &result, const char *name, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool getValueByName (std::string &result, const char *namename, TEval evaluate=Eval, TWhereIsValue *where=NULL, uint32 round=0) const=0
virtual bool isArray () const=0
 Return true if the element is an array.

virtual bool isAtom () const=0
 Return true if the element is an atom.

virtual bool isStruct () const=0
 Return true if the element is a struct or a virtual struct.

virtual bool isVirtualStruct () const=0
 Return true if the element is a virtual struct.

virtual bool setValueByName (NLMISC::CRGBA value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (bool value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (double value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (float value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (uint32 value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (sint32 value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (uint16 value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (sint16 value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (uint8 value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (sint8 value, const char *name, bool *created=NULL)=0
virtual bool setValueByName (const char *value, const char *name, bool *created=NULL)=0
+

Member Enumeration Documentation

+

+ + + + +
+ + +
enum NLGEORGES::UFormElm::TEval +
+
+ + + + + +
+   + + +

+Value evalution. +

+

Enumeration values:
+ + + + +
NoEval  +
Formula  +The value will not be evaluated at all, the litteral value will be returned.
Eval  +Eval the enumeration value, but don't evaluate the formula nor the value references.
+
+ +

+Definition at line 47 of file u_form_elm.h. +

+

00048         {               
+00049                 NoEval,                         
+00050                 Formula,                        
+00051                 Eval,                           
+00052         };
+
+

+ + + + +
+ + +
enum NLGEORGES::UFormElm::TWhereIsNode +
+
+ + + + + +
+   + + +

+Where a node has been found. +

+

Enumeration values:
+ + + + + +
NodeForm  +
NodeParentForm  +The node has been found in the form.
NodeDfn  +The node has been found in the parent form.
NodeType  +The node is a DFN.
+
+ +

+Definition at line 55 of file u_form_elm.h. +

+

00056         {
+00057                 NodeForm,                       
+00058                 NodeParentForm,         
+00059                 NodeDfn,                        
+00060                 NodeType,                       
+00061         };
+
+

+ + + + +
+ + +
enum NLGEORGES::UFormElm::TWhereIsValue +
+
+ + + + + +
+   + + +

+Where a value has been found. +

+

Enumeration values:
+ + + + + + +
ValueForm  +
ValueParentForm  +The value has been found in the form.
ValueDefaultDfn  +The value has been found in the parent form.
ValueDefaultType  +The value has been found in the DFN default value.
Dummy  +The value has been found in the TYPE default value.
+
+ +

+Definition at line 94 of file u_form_elm.h. +

+

00095         {
+00096                 ValueForm,                              
+00097                 ValueParentForm,                
+00098                 ValueDefaultDfn,                
+00099                 ValueDefaultType,               
+00100                 Dummy = 0xffffffff              
+00101         };
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayNode ( UFormElm **  result,
uint  arrayIndex
)  [pure virtual]
+
+ + + + + +
+   + + +

+Get a array sub element mutable pointer. If return true, fill result with the arrayIndex cell's element pointer. Can be NULL if the node doesn't exist. +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayNode ( const UFormElm **  result,
uint  arrayIndex
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Get a array sub element const pointer. If return true, fill result with the arrayIndex cell's element Can be NULL if the node doesn't exist. +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. +

+Referenced by NLSOUND::CBackgroundSound::importForm(), NLSOUND::CSampleBank::init(), NLSOUND::CAudioMixerUser::init(), and NLSOUND::CSoundGroupSerializer::readGeorges().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayNodeName ( std::string &  result,
uint  arrayIndex
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Return the name of a table element. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArraySize ( uint &  size  )  const [pure virtual]
+
+ + + + + +
+   + + +

+Return true if the element is an array and fill size with the array size. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. +

+Referenced by NLSOUND::CComplexSound::importForm(), NLSOUND::CBackgroundSound::importForm(), NLSOUND::CSampleBank::init(), NLSOUND::CAudioMixerUser::init(), NLSOUND::CSoundGroupSerializer::readGeorges(), and NLSOUND::CUserVarSerializer::readGeorges().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( NLMISC::CRGBA &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Warning, only R, G and B members are filled, not A. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( bool &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( double &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( float &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( uint32 &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( sint32 &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( uint16 &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( sint16 &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( uint8 &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( sint8 &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getArrayValue ( std::string &  result,
uint  arrayIndex,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Get an array value. The node must be an array of atom element.

+

Parameters:
+ + + + + +
result is a reference on the value to fill with the result.
arrayIndex is the array index to evaluate.
evaluate must be true if you want to have an evaluated value, false if you want the formula value.
where is a pointer on the information flag of the value. If Where is not NULL, it is filled with the position where the value has been found.
+
+
Returns:
true if the result has been filled, false if the value has not been found or the cast has failed or the evaluation has failed.
+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. +

+Referenced by NLSOUND::CComplexSound::importForm(), NLSOUND::CAudioMixerUser::init(), and NLSOUND::CUserVarSerializer::readGeorges().

+

+ + + + +
+ + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getDfnName ( std::string &  dfnName  )  const [pure virtual]
+
+ + + + + +
+   + + +

+Get the dfn filename for this virtual struct. Must be a virtual struct node. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmVirtualStruct. +

+Referenced by NLSOUND::CSound::createSound(), NLSOUND::CSimpleSound::importForm(), NLSOUND::CContextSound::importForm(), NLSOUND::CComplexSound::importForm(), and NLSOUND::CBackgroundSound::importForm().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getNodeByName ( UFormElm **  result,
const char *  name,
TWhereIsNode *  where = NULL,
bool  reserved = true,
uint32  round = 0
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getNodeByName ( const UFormElm **  result,
const char *  name,
TWhereIsNode *  where = NULL,
bool  reserved = true,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Return a node pointer with its name.

+

Parameters:
+ + + + +
result will be filled with the node pointer. Can be NULL if the node doesn't exist.
name is the form node name
where is a pointer on the information flag of the value. If Where is not NULL, it is filled with the position where the node has been found. If result is NULL, where is undefined.
+
+
Returns:
true if the result has been filled, false if the node is not referenced.
+About the node existance

+An atom node exist if its value are defined. A struct node exist if one of its children exist. An array node exist if one of its children exist. If the node doesn't exist, you can't have a pointer on it with getNodeByName(). It returns NULL. But, you can evaluate the value of non-existant atom nodes with getValueByName().

+About the form name:

+Struct elements name must be separeted by '.' Struct indexes must be between '[' and ']'

+Exemple: "position.x" : get the element named x in the struct named position "entities[2].color" : get the node named color in the second element of the entities array +

+Implemented in NLGEORGES::CFormElm. +

+Referenced by NLSOUND::CSound::createSound(), NLGEORGES::CFormElm::getIternalNodeByName(), NLSOUND::CSimpleSound::importForm(), NLSOUND::CContextSound::importForm(), NLSOUND::CComplexSound::importForm(), NLSOUND::CBackgroundSound::importForm(), NLSOUND::CSampleBank::init(), NLSOUND::CAudioMixerUser::init(), NLSOUND::CSoundGroupSerializer::readGeorges(), and NLSOUND::CUserVarSerializer::readGeorges().

+

+ + + + +
+ + + + + + + + + +
virtual class UFormDfn* NLGEORGES::UFormElm::getStructDfn (   )  [pure virtual]
+
+ + + + + +
+   + + +

+Return the struct dfn. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getStructNode ( uint  element,
UFormElm **  result
)  [pure virtual]
+
+ + + + + +
+   + + +

+Return a mutable element pointer. Can be NULL if the node doesn't exist. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getStructNode ( uint  element,
const UFormElm **  result
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Return a const element pointer. Can be NULL if the node doesn't exist. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getStructNodeName ( uint  element,
std::string &  result
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Return the element name. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct.

+

+ + + + +
+ + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getStructSize ( uint &  size  )  const [pure virtual]
+
+ + + + + +
+   + + +

+Return the struct size. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( NLMISC::CRGBA &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Warning, only R, G and B members are filled, not A. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( bool &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( double &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( float &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( uint32 &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( sint32 &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( uint16 &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( sint16 &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( uint8 &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( sint8 &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValue ( std::string &  result,
TEval  evaluate = Eval
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Return the atom value. The numbers are clamped to the type limit values.

+

Parameters:
+ + + +
result is the reference on the value to fill with result
evaluate must be true if you want to have an evaluated value, false if you want the formula value.
+
+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( NLMISC::CRGBA &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Warning, only R, G and B members are filled, not A. +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( bool &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( double &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( float &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( uint32 &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( sint32 &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( uint16 &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( sint16 &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( uint8 &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( sint8 &  result,
const char *  name,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::getValueByName ( std::string &  result,
const char *  namename,
TEval  evaluate = Eval,
TWhereIsValue *  where = NULL,
uint32  round = 0
)  const [pure virtual]
+
+ + + + + +
+   + + +

+Get a form value with its name. The numbers are clamped to the type limit values.

+

Parameters:
+ + + + + +
result is a reference on the value to fill with the result.
name is the form name of the value to found.
evaluate must be true if you want to have an evaluated value, false if you want the formula value.
where is a pointer on the information flag of the value. If Where is not NULL, it is filled with the position where the value has been found.
+
+
Returns:
true if the result has been filled, false if the value has not been found or the cast has failed or the evaluation has failed.
+
See also:
getNodeByName ()
+ +

+Implemented in NLGEORGES::CFormElm. +

+Referenced by NLSOUND::CSound::importForm(), NLSOUND::CSimpleSound::importForm(), NLSOUND::CContextSound::importForm(), NLSOUND::CComplexSound::importForm(), NLSOUND::CBackgroundSound::importForm(), NLSOUND::CSampleBank::init(), NLSOUND::CAudioMixerUser::init(), NLSOUND::CSoundGroupSerializer::readGeorges(), and NLSOUND::CUserVarSerializer::readGeorges().

+

+ + + + +
+ + + + + + + + + +
virtual bool NLGEORGES::UFormElm::isArray (   )  const [pure virtual]
+
+ + + + + +
+   + + +

+Return true if the element is an array. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. +

+Referenced by NLSOUND::CBackgroundSound::importForm().

+

+ + + + +
+ + + + + + + + + +
virtual bool NLGEORGES::UFormElm::isAtom (   )  const [pure virtual]
+
+ + + + + +
+   + + +

+Return true if the element is an atom. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom.

+

+ + + + +
+ + + + + + + + + +
virtual bool NLGEORGES::UFormElm::isStruct (   )  const [pure virtual]
+
+ + + + + +
+   + + +

+Return true if the element is a struct or a virtual struct. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct.

+

+ + + + +
+ + + + + + + + + +
virtual bool NLGEORGES::UFormElm::isVirtualStruct (   )  const [pure virtual]
+
+ + + + + +
+   + + +

+Return true if the element is a virtual struct. +

+ +

+Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmVirtualStruct. +

+Referenced by NLGEORGES::CFormElm::getIternalNodeByName().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( NLMISC::CRGBA  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( bool  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( double  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( float  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( uint32  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( sint32  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( uint16  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( sint16  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( uint8  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( sint8  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+ +

+Implemented in NLGEORGES::CFormElm.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool NLGEORGES::UFormElm::setValueByName ( const char *  value,
const char *  name,
bool *  created = NULL
)  [pure virtual]
+
+ + + + + +
+   + + +

+Set a form value with its name. If the node doesn't exist, it is created.

+

Parameters:
+ + + + + +
value is a reference on the value to set in the form.
name is the form name of the value to set or create.
where is a pointer on the information flag of the value. If Where is not NULL, it is filled with the position where the value has been found.
created is a pointer on the creatation flag. If created is not NULL, it is filled with true if the value has been created, false it the value has been filled.
+
+
Returns:
true if the value has been set, false if the value has not been found or hasn't been created.
+ +

+Implemented in NLGEORGES::CFormElm.

+

The documentation for this class was generated from the following file: +
Generated on Tue Mar 16 12:46:49 2004 for NeL by + +doxygen +1.3.6
+ + -- cgit v1.2.1