#include <u_form_elm.h>
Inheritance diagram for NLGEORGES::UFormElm:
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 |
|
Value evalution.
Definition at line 47 of file u_form_elm.h.
|
|
Where a node has been found.
Definition at line 55 of file u_form_elm.h.
00056 { 00057 NodeForm, 00058 NodeParentForm, 00059 NodeDfn, 00060 NodeType, 00061 }; |
|
Where a value has been found.
Definition at line 94 of file u_form_elm.h.
00095 { 00096 ValueForm, 00097 ValueParentForm, 00098 ValueDefaultDfn, 00099 ValueDefaultType, 00100 Dummy = 0xffffffff 00101 }; |
|
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. |
|
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(). |
|
Return the name of a table element.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
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(). |
|
Warning, only R, G and B members are filled, not A.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. |
|
Get an array value. The node must be an array of atom element.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. Referenced by NLSOUND::CComplexSound::importForm(), NLSOUND::CAudioMixerUser::init(), and NLSOUND::CUserVarSerializer::readGeorges(). |
|
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(). |
|
Implemented in NLGEORGES::CFormElm. |
|
Return a node pointer with its name.
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(). |
|
Return the struct dfn.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct. |
|
Return a mutable element pointer. Can be NULL if the node doesn't exist.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct. |
|
Return a const element pointer. Can be NULL if the node doesn't exist.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct. |
|
Return the element name.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct. |
|
Return the struct size.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct. |
|
Warning, only R, G and B members are filled, not A.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Return the atom value. The numbers are clamped to the type limit values.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Warning, only R, G and B members are filled, not A.
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Get a form value with its name. The numbers are clamped to the type limit values.
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(). |
|
Return true if the element is an array.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmArray. Referenced by NLSOUND::CBackgroundSound::importForm(). |
|
Return true if the element is an atom.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmAtom. |
|
Return true if the element is a struct or a virtual struct.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmStruct. |
|
Return true if the element is a virtual struct.
Implemented in NLGEORGES::CFormElm, and NLGEORGES::CFormElmVirtualStruct. Referenced by NLGEORGES::CFormElm::getIternalNodeByName(). |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Implemented in NLGEORGES::CFormElm. |
|
Set a form value with its name. If the node doesn't exist, it is created.
Implemented in NLGEORGES::CFormElm. |