NLLIGO::IPrimitive Class Reference

#include <primitive.h>

Inheritance diagram for NLLIGO::IPrimitive:

Properties
bool	addPropertyByName (const char *property_name, IProperty *result)
virtual IPrimitive *	copy () const=0
uint	getNumProperty () const
virtual uint	getNumVector () const=0
virtual CPrimVector *	getPrimVector ()=0
virtual const CPrimVector *	getPrimVector () const=0
bool	getProperty (uint index, std::string &property_name, IProperty *&result)
bool	getProperty (uint index, std::string &property_name, const IProperty *&result) const
bool	getPropertyByName (const char *property_name, NLMISC::CRGBA &result) const
bool	getPropertyByName (const char *property_name, const std::vector< std::string > *&result) const
bool	getPropertyByName (const char *property_name, std::string &result) const
bool	getPropertyByName (const char *property_name, std::vector< std::string > *&result) const
bool	getPropertyByName (const char *property_name, std::string *&result) const
bool	getPropertyByName (const char *property_name, IProperty *&result) const
bool	getPropertyByName (const char *property_name, const IProperty *&result) const
virtual bool	read (xmlNodePtr xmlNode, const char *filename, uint version, CLigoConfig &config)
void	removeProperties ()
bool	removeProperty (uint index)
bool	removePropertyByName (const char *property_name)
virtual void	write (xmlNodePtr xmlNode, const char *filename) const
void	updateChildId (uint index)
uint	_ChildId
std::vector< IPrimitive * >	_Children
IPrimitive *	_Parent
std::map< std::string, IProperty * >	_Properties
Hierarchy
bool	getChild (IPrimitive *&result, uint childId)
bool	getChild (const IPrimitive *&result, uint childId) const
bool	getChildId (uint &childId, const IPrimitive *child) const
uint	getNumChildren () const
const IPrimitive *	getParent () const
IPrimitive *	getParent ()
bool	insertChild (IPrimitive *primitive, uint index=AtTheEnd)
	IPrimitive (const IPrimitive &node)
	IPrimitive ()
virtual void	operator= (const IPrimitive &node)
bool	removeChild (uint childId)
void	removeChildren ()
virtual	~IPrimitive ()
Public Types
enum	{ NotAnArray, AtTheEnd = 0xffffffff }
Public Member Functions
virtual std::string	getClassName ()=0
Data Fields
bool	Expanded
std::string	Layer
std::string	Name

---

Member Enumeration Documentation

anonymous enum

Enumeration values: NotAnArray  AtTheEnd  Definition at line 165 of file primitive.h. { NotAnArray, AtTheEnd = 0xffffffff, };

---

Constructor & Destructor Documentation

NLLIGO::IPrimitive::IPrimitive (   )  [inline]

Get a child primitive Definition at line 172 of file primitive.h. { _Parent = NULL; };

NLLIGO::IPrimitive::~IPrimitive (   )  [virtual]

Get a child primitive Definition at line 1373 of file primitive.cpp. References removeChildren(), and removeProperties(). { // Remove children removeChildren (); // Erase properties removeProperties (); }

NLLIGO::IPrimitive::IPrimitive (  const IPrimitive &  node  )

Get a child primitive Definition at line 976 of file primitive.cpp. { _Parent = NULL; IPrimitive::operator= (node); }

---

Member Function Documentation

bool NLLIGO::IPrimitive::addPropertyByName (  const char *  property_name, IProperty *  result )

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Definition at line 1384 of file primitive.cpp. References _Properties. Referenced by NLLIGO::CPrimitives::convertAddPrimitive(), NLLIGO::CPrimitives::convertPrimitive(), and read(). { bool inserted = _Properties.insert (std::map<std::string, IProperty*>::value_type (property_name, result)).second; if (inserted) { return true; } return false; }

virtual IPrimitive* NLLIGO::IPrimitive::copy (   )  const [pure virtual]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Implemented in NLLIGO::CPrimNode, NLLIGO::CPrimPoint, NLLIGO::CPrimPath, and NLLIGO::CPrimZone.

bool NLLIGO::IPrimitive::getChild (  IPrimitive *&  result, uint  childId )

Get a child primitive Definition at line 1303 of file primitive.cpp. References nlwarning, and uint. { if (childId < _Children.size ()) { result = _Children[childId]; return true; } else { nlwarning ("NLLIGO::IPrimitive::getChild : invalid index (index : %d, size %d).", childId, _Children.size ()); } return false; }

bool NLLIGO::IPrimitive::getChild (  const IPrimitive *&  result, uint  childId )  const

Get a child primitive Definition at line 1287 of file primitive.cpp. References nlwarning, and uint. Referenced by NLLIGO::CPrimitives::convertPrimitive(), NLSOUND::CBackgroundSoundManager::loadAudioFromPrimitives(), NLSOUND::CBackgroundSoundManager::loadEffectsFromPrimitives(), NLSOUND::CBackgroundSoundManager::loadSamplesFromPrimitives(), and NLSOUND::CBackgroundSoundManager::loadSoundsFromPrimitives(). { if (childId < _Children.size ()) { result = _Children[childId]; return true; } else { nlwarning ("NLLIGO::IPrimitive::getChild : invalid index (index : %d, size %d).", childId, _Children.size ()); } return false; }

bool NLLIGO::IPrimitive::getChildId (  uint &  childId, const IPrimitive *  child )  const

Get the id of the child, return 0xffffffff if not found Definition at line 1713 of file primitive.cpp. References _ChildId, and uint. { childId = child->_ChildId; return true; }

virtual std::string NLMISC::IClassable::getClassName (   )  [pure virtual, inherited]

Implemented in NLAIAGENT::CNumericIndex, NLAIC::IPointerGestion, NLAIC::CIdentType, and CAutomataDesc. Referenced by NLMISC::CClassRegistry::checkObject(), and NL3D::GetTextureSize().

uint NLLIGO::IPrimitive::getNumChildren (   )  const [inline]

Get the children primitive count Definition at line 183 of file primitive.h. References uint. Referenced by NLLIGO::CPrimitives::convertPrimitive(), NLSOUND::CBackgroundSoundManager::loadAudioFromPrimitives(), NLSOUND::CBackgroundSoundManager::loadEffectsFromPrimitives(), NLSOUND::CBackgroundSoundManager::loadSamplesFromPrimitives(), and NLSOUND::CBackgroundSoundManager::loadSoundsFromPrimitives(). { return _Children.size (); }

uint NLLIGO::IPrimitive::getNumProperty (   )  const

Get a num properties Definition at line 1721 of file primitive.cpp. References _Properties, and uint. { return _Properties.size (); }

virtual uint NLLIGO::IPrimitive::getNumVector (   )  const [pure virtual]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Implemented in NLLIGO::CPrimPoint, NLLIGO::CPrimPath, and NLLIGO::CPrimZone. Referenced by NLSOUND::CBackgroundSoundManager::loadSoundsFromPrimitives().

const IPrimitive* NLLIGO::IPrimitive::getParent (   )  const [inline]

Get a child primitive Definition at line 199 of file primitive.h. { return _Parent; }

IPrimitive* NLLIGO::IPrimitive::getParent (   )  [inline]

Get the parent primtive Definition at line 195 of file primitive.h. Referenced by NLLIGO::CLigoConfig::canBeChild(), and NLLIGO::CLigoConfig::getPrimitiveClass(). { return _Parent; }

virtual CPrimVector* NLLIGO::IPrimitive::getPrimVector (   )  [pure virtual]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Implemented in NLLIGO::CPrimNode, NLLIGO::CPrimPoint, NLLIGO::CPrimPath, and NLLIGO::CPrimZone.

virtual const CPrimVector* NLLIGO::IPrimitive::getPrimVector (   )  const [pure virtual]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Implemented in NLLIGO::CPrimPoint, NLLIGO::CPrimPath, and NLLIGO::CPrimZone.

bool NLLIGO::IPrimitive::getProperty (  uint  index, std::string &  property_name, IProperty *&  result )

Get a properties by its index This is method (iterate a list) is slower than getPropertyByName (look up in a map). Definition at line 1081 of file primitive.cpp. References _Properties, index, nlwarning, and uint. { // Look for the property std::map<std::string, IProperty*>::iterator ite = _Properties.begin (); while (ite != _Properties.end ()) { if (index == 0) { property_name = ite->first; result = ite->second; return true; } index--; ite ++; } nlwarning ("NLLIGO::IPrimitive::getProperty : invalid index (index : %d, size : %d).", index, _Properties.size ()); return false; }

bool NLLIGO::IPrimitive::getProperty (  uint  index, std::string &  property_name, const IProperty *&  result )  const

Get a properties by its index This is method (iterate a list) is slower than getPropertyByName (look up in a map). Definition at line 1060 of file primitive.cpp. References _Properties, index, nlwarning, and uint. { // Look for the property std::map<std::string, IProperty*>::const_iterator ite = _Properties.begin (); while (ite != _Properties.end ()) { if (index == 0) { property_name = ite->first; result = ite->second; return true; } index--; ite ++; } nlwarning ("NLLIGO::IPrimitive::getProperty : invalid index (index : %d, size : %d).", index, _Properties.size ()); return false; }

bool NLLIGO::IPrimitive::getPropertyByName (  const char *  property_name, NLMISC::CRGBA &  result )  const

Get a color property with its name. Return false if the property is not found or is not a string array property. Definition at line 1218 of file primitive.cpp. References NLLIGO::CPropertyColor::Color, getPropertyByName(), and nlwarning. { // Get the property IProperty *prop; if (getPropertyByName (property_name, prop)) { const CPropertyColor *colorProp = dynamic_cast<const CPropertyColor *> (prop); if (colorProp) { result = colorProp->Color; return true; } else { nlwarning ("NLLIGO::IPrimitive::getPropertyByName : property (%s) in not a color.", property_name); } } return false; }

bool NLLIGO::IPrimitive::getPropertyByName (  const char *  property_name, const std::vector< std::string > *&  result )  const

Get a string array property with its name. Return false if the property is not found or is not a string array property. Definition at line 1196 of file primitive.cpp. References getPropertyByName(), nlwarning, and NLLIGO::CPropertyStringArray::StringArray. { // Get the property IProperty *prop; if (getPropertyByName (property_name, prop)) { const CPropertyStringArray *strProp = dynamic_cast<const CPropertyStringArray *> (prop); if (strProp) { result = &(strProp->StringArray); return true; } else { nlwarning ("NLLIGO::IPrimitive::getPropertyByName : property (%s) in not a string.", property_name); } } return false; }

bool NLLIGO::IPrimitive::getPropertyByName (  const char *  property_name, std::string &  result )  const

Get a string property with its name. Return false if the property is not found or is not a string property. Definition at line 1152 of file primitive.cpp. References getPropertyByName(), nlwarning, and NLLIGO::CPropertyString::String. { // Get the property const IProperty *prop; if (getPropertyByName (property_name, prop)) { const CPropertyString *strProp = dynamic_cast<const CPropertyString *> (prop); if (strProp) { result = strProp->String; return true; } else { nlwarning ("NLLIGO::IPrimitive::getPropertyByName : property (%s) in not a string.", property_name); } } return false; }

bool NLLIGO::IPrimitive::getPropertyByName (  const char *  property_name, std::vector< std::string > *&  result )  const

Get a string array property with its name. Return false if the property is not found or is not a string array property. Definition at line 1174 of file primitive.cpp. References getPropertyByName(), nlwarning, and NLLIGO::CPropertyStringArray::StringArray. { // Get the property IProperty *prop; if (getPropertyByName (property_name, prop)) { CPropertyStringArray *strProp = dynamic_cast<CPropertyStringArray *> (prop); if (strProp) { result = &(strProp->StringArray); return true; } else { nlwarning ("NLLIGO::IPrimitive::getPropertyByName : property (%s) in not a string.", property_name); } } return false; }

bool NLLIGO::IPrimitive::getPropertyByName (  const char *  property_name, std::string *&  result )  const

Get a string property with its name. Return false if the property is not found or is not a string property. Definition at line 1130 of file primitive.cpp. References getPropertyByName(), nlwarning, and NLLIGO::CPropertyString::String. { // Get the property IProperty *prop; if (getPropertyByName (property_name, prop)) { CPropertyString *strProp = dynamic_cast<CPropertyString *> (prop); if (strProp) { result = &(strProp->String); return true; } else { nlwarning ("NLLIGO::IPrimitive::getPropertyByName : property (%s) in not a string.", property_name); } } return false; }

bool NLLIGO::IPrimitive::getPropertyByName (  const char *  property_name, IProperty *&  result )  const

Get a property with its name Definition at line 1116 of file primitive.cpp. References _Properties. { // Look for the property std::map<std::string, IProperty*>::const_iterator ite = _Properties.find (property_name); if (ite != _Properties.end ()) { result = ite->second; return true; } return false; }

bool NLLIGO::IPrimitive::getPropertyByName (  const char *  property_name, const IProperty *&  result )  const

Get a property with its name Definition at line 1102 of file primitive.cpp. References _Properties. Referenced by NLLIGO::CPrimitiveConfigurations::belong(), NLLIGO::CLigoConfig::canBeChild(), NLLIGO::CLigoConfig::canBeRoot(), NLLIGO::CPrimitives::convertPrimitive(), NLLIGO::CLigoConfig::getPrimitiveClass(), NLLIGO::CLigoConfig::getPrimitiveColor(), getPropertyByName(), NLLIGO::CLigoConfig::isPrimitiveDeletable(), NLLIGO::CLigoConfig::isPrimitiveLinked(), NLSOUND::CBackgroundSoundManager::loadAudioFromPrimitives(), NLSOUND::CBackgroundSoundManager::loadEffectsFromPrimitives(), NLSOUND::CBackgroundSoundManager::loadSamplesFromPrimitives(), NLSOUND::CBackgroundSoundManager::loadSoundsFromPrimitives(), read(), and NLLIGO::CPrimitiveClass::CParameter::translateAutoname(). { // Look for the property std::map<std::string, IProperty*>::const_iterator ite = _Properties.find (property_name); if (ite != _Properties.end ()) { result = ite->second; return true; } return false; }

bool NLLIGO::IPrimitive::insertChild (  IPrimitive *  primitive, uint  index = AtTheEnd )

Insert a child primitive before the index. The pointer will be deleted by the parent primitive using the ::delete operator. return false if the index is invalid Definition at line 1349 of file primitive.cpp. References _Parent, AtTheEnd, index, uint, and updateChildId(). Referenced by NLLIGO::CPrimitives::convertAddPrimitive(), NLLIGO::CPrimitives::convertPrimitive(), and read(). { // At the end ? if (index == AtTheEnd) index = _Children.size (); // Index valid ? if (index>_Children.size ()) return false; // Insert _Children.insert (_Children.begin () + index, primitive); // Update child id updateChildId (index); // Link to the parent primitive->_Parent = this; return true; }

void NLLIGO::IPrimitive::operator= (  const IPrimitive &  node  )  [virtual]

Get a child primitive Definition at line 994 of file primitive.cpp. References _ChildId, _Children, _Properties, Expanded, Layer, Name, nlverify, removeChildren(), removeProperties(), and uint. { // Clean dest removeChildren (); removeProperties (); // copy deprecated param Layer = node.Layer; Name = node.Name; // Copy the flags Expanded = node.Expanded; _ChildId = node._ChildId; // Copy children _Children.resize (node._Children.size ()); for (uint child = 0; child < node._Children.size (); child++) { // Copy the child _Children[child] = node._Children[child]->copy (); // Set the parent _Children[child]->_Parent = this; } // Copy properties std::map<std::string, IProperty*>::const_iterator ite = node._Properties.begin (); while (ite != node._Properties.end ()) { // Get the property CPropertyString *propString = dynamic_cast<CPropertyString *>(ite->second); if (propString) { // New property CPropertyString *newProp = new CPropertyString (); *newProp = *propString; _Properties.insert (std::map<std::string, IProperty*>::value_type (ite->first, newProp)); } else { CPropertyStringArray *propStringArray = dynamic_cast<CPropertyStringArray *>(ite->second); if (propStringArray) { // New property CPropertyStringArray *newProp = new CPropertyStringArray (); *newProp = *propStringArray; _Properties.insert (std::map<std::string, IProperty*>::value_type (ite->first, newProp)); } else { CPropertyColor *propColor = dynamic_cast<CPropertyColor *>(ite->second); nlverify (propColor); // New property CPropertyColor *newProp = new CPropertyColor (); *newProp = *propColor; _Properties.insert (std::map<std::string, IProperty*>::value_type (ite->first, newProp)); } } ite++; } }

bool NLLIGO::IPrimitive::read (  xmlNodePtr  xmlNode, const char *  filename, uint  version, CLigoConfig &  config )  [virtual]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Reimplemented in NLLIGO::CPrimNode, NLLIGO::CPrimPoint, NLLIGO::CPrimPath, and NLLIGO::CPrimZone. Definition at line 1396 of file primitive.cpp. References _Properties, addPropertyByName(), NLMISC::clamp(), count, NLLIGO::IProperty::Default, Expanded, NLLIGO::GetContentString(), NLLIGO::CPrimitiveClass::CParameter::getDefaultValue(), NLLIGO::GetNodeString(), NLLIGO::CLigoConfig::getPrimitiveClass(), getPropertyByName(), NLLIGO::GetPropertyString(), insertChild(), NLLIGO::CPrimitiveClass::CInitParameters::Name, nlverify, NLLIGO::CPrimitiveClass::Parameters, sint32, NLLIGO::CPropertyString::String, NLLIGO::CPropertyStringArray::StringArray, NLLIGO::CPrimitiveClass::CParameter::Type, type, uint, uint8, and NLLIGO::XMLError(). { // Erase old properties _Properties.clear (); // Read the expanded flag string expanded; Expanded = true; if (CIXml::getPropertyString (expanded, xmlNode, "EXPANDED")) Expanded = (expanded != "false"); // Read the properties xmlNodePtr propNode; propNode = CIXml::getFirstChildNode (xmlNode, "PROPERTY"); if (propNode) { do { // Read the name string name; if (GetNodeString (name, filename, propNode, "NAME")) { // Get the property type string type; if (GetPropertyString (type, filename, propNode, "TYPE")) { // The property IProperty *property = NULL; // Check the type if (type == "string") { // Create a new property CPropertyString *propertyString = new CPropertyString; property = propertyString; // Read it if (!GetNodeString (propertyString->String, filename, propNode, "STRING")) { return false; } } else if (type == "string_array") { // Create a new property CPropertyStringArray *propertyStringArray = new CPropertyStringArray; property = propertyStringArray; // Read strings xmlNodePtr stringNode; propertyStringArray->StringArray.reserve (CIXml::countChildren (propNode, "STRING")); stringNode = CIXml::getFirstChildNode (propNode, "STRING"); if (stringNode) { do { // Add the string string content; GetContentString (content, filename, stringNode); propertyStringArray->StringArray.push_back (content); } while ((stringNode = CIXml::getNextChildNode (stringNode, "STRING"))); } } else if (type == "color") { // Create a new property CPropertyColor *propertyColor= new CPropertyColor; property = propertyColor; // Read strings xmlNodePtr colorNode; colorNode = CIXml::getFirstChildNode (xmlNode, "COLOR"); string R, G, B, A; if (GetPropertyString (R, filename, colorNode, "R") && GetPropertyString (G, filename, colorNode, "G") && GetPropertyString (B, filename, colorNode, "B") && GetPropertyString (A, filename, colorNode, "A")) { sint32 sR=0, sG=0, sB=0, sA=255; sR = atoi (R.c_str ()); clamp (sR, 0, 255); sG = atoi (G.c_str ()); clamp (sG, 0, 255); sB = atoi (B.c_str ()); clamp (sB, 0, 255); sA = atoi (A.c_str ()); clamp (sR, 0, 255); propertyColor->Color.R = (uint8)sR; propertyColor->Color.G = (uint8)sG; propertyColor->Color.B = (uint8)sB; propertyColor->Color.A = (uint8)sA; } else return false; } // Property found ? if (property == NULL) { XMLError (propNode, filename, "IPrimitive::read : Unknown property type (%s)", type.c_str ()); return false; } // Add it _Properties.insert (std::map<std::string, IProperty*>::value_type (name, property)); } else { return false; } } else { return false; } } while ((propNode = CIXml::getNextChildNode (propNode, "PROPERTY"))); } // Get the primitive class const CPrimitiveClass *primitiveClass = config.getPrimitiveClass (*this); if (primitiveClass) { // For each properties uint count = primitiveClass->Parameters.size (); uint i; for (i=0; i<count; i++) { const CPrimitiveClass::CParameter &parameter = primitiveClass->Parameters[i]; // Get the property IProperty *result; if (!getPropertyByName (parameter.Name.c_str(), result)) { // Create the property if ((parameter.Type == CPrimitiveClass::CParameter::StringArray) || (parameter.Type == CPrimitiveClass::CParameter::ConstStringArray)) result = new CPropertyStringArray(); else result = new CPropertyString(); nlverify (addPropertyByName (parameter.Name.c_str(), result)); } } // Set the default values for (i=0; i<count; i++) { const CPrimitiveClass::CParameter &parameter = primitiveClass->Parameters[i]; CPropertyString *pString = NULL; CPropertyStringArray *pStringArray = NULL; IProperty *result; nlverify (getPropertyByName (parameter.Name.c_str(), result)); pString = dynamic_cast<CPropertyString*>(result); if (!pString) pStringArray = dynamic_cast<CPropertyStringArray*>(result); // Property have default values ? if (pString) { // Empty string ? if (pString->String.empty()) { // Set as default pString->Default = true; parameter.getDefaultValue (pString->String, *this, *primitiveClass); } } else if (pStringArray) { // Empty string array ? if (pStringArray->StringArray.empty()) { // Set as default pStringArray->Default = true; parameter.getDefaultValue (pStringArray->StringArray, *this, *primitiveClass); } } } } // Read children xmlNodePtr childNode; childNode = CIXml::getFirstChildNode (xmlNode, "CHILD"); if (childNode) { do { // Get the property class string type; if (GetPropertyString (type, filename, childNode, "TYPE")) { // Primitive if (type=="node") type="CPrimNode"; if (type=="point") type="CPrimPoint"; if (type=="path") type="CPrimPath"; if (type=="zone") type="CPrimZone"; IPrimitive *primitive = static_cast<IPrimitive *> (CClassRegistry::create (type)); // Primitive type not found ? if (primitive == NULL) { XMLError (childNode, filename, "IPrimitive::read : Unknown primitive type (%s)", type.c_str ()); return false; } // Read it primitive->read (childNode, filename, version, config); // Add it insertChild (primitive); } else { return false; } } while ((childNode = CIXml::getNextChildNode (childNode, "CHILD"))); } // Done return true; }

bool NLLIGO::IPrimitive::removeChild (  uint  childId  )

Remove a child primitive Definition at line 1319 of file primitive.cpp. References nlwarning, uint, and updateChildId(). { if (childId < _Children.size ()) { delete _Children[childId]; _Children.erase (_Children.begin()+childId); updateChildId (childId); return true; } else { nlwarning ("NLLIGO::IPrimitive::removeChild : invalid index (index : %d, size %d).", childId, _Children.size ()); } return false; }

void NLLIGO::IPrimitive::removeChildren (   )

Remove all children primitives Definition at line 1337 of file primitive.cpp. References uint. Referenced by NLLIGO::CPrimitives::convert(), operator=(), NLLIGO::CPrimitives::read(), and ~IPrimitive(). { // Erase children for (uint i=0; i<_Children.size (); i++) { delete _Children[i]; } _Children.clear (); }

void NLLIGO::IPrimitive::removeProperties (   )

Remove all the properties Definition at line 1274 of file primitive.cpp. References _Properties. Referenced by NLLIGO::CPrimitives::convert(), operator=(), NLLIGO::CPrimitives::read(), and ~IPrimitive(). { std::map<std::string, IProperty*>::iterator ite = _Properties.begin (); while (ite != _Properties.end ()) { delete ite->second; ite++; } _Properties.clear (); }

bool NLLIGO::IPrimitive::removeProperty (  uint  index  )

Remove a property This is method (iterate a list) is slower than removePropertyByName (look up in a map). Definition at line 1240 of file primitive.cpp. References _Properties, index, nlwarning, and uint. { // Look for the property std::map<std::string, IProperty*>::iterator ite = _Properties.begin (); while (ite != _Properties.end ()) { if (index == 0) { _Properties.erase (ite); return true; } index--; ite ++; } nlwarning ("NLLIGO::IPrimitive::removeProperty : invalid index (index : %d, size : %d).", index, _Properties.size ()); return false; }

bool NLLIGO::IPrimitive::removePropertyByName (  const char *  property_name  )

Remove a property by its name Definition at line 1260 of file primitive.cpp. References _Properties. { // Look for the property std::map<std::string, IProperty*>::iterator ite = _Properties.find (property_name); if (ite != _Properties.end ()) { _Properties.erase (ite); return true; } return false; }

void NLLIGO::IPrimitive::updateChildId (  uint  index  )  [private]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Definition at line 984 of file primitive.cpp. References count, index, and uint. Referenced by insertChild(), and removeChild(). { uint i; uint count = _Children.size (); for (i=index; i<count; i++) _Children[i]->_ChildId = i; }

void NLLIGO::IPrimitive::write (  xmlNodePtr  xmlNode, const char *  filename )  const [virtual]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Reimplemented in NLLIGO::CPrimPoint, NLLIGO::CPrimPath, and NLLIGO::CPrimZone. Definition at line 1627 of file primitive.cpp. References _Properties, NLMISC::CRGBA::A, NLMISC::CRGBA::B, NLLIGO::CPropertyColor::Color, Expanded, NLMISC::CRGBA::G, NLMISC::CRGBA::R, NLLIGO::CPropertyString::String, NLLIGO::CPropertyStringArray::StringArray, NLMISC::toString(), and uint. { // Save the expanded flag if (!Expanded) xmlSetProp (xmlNode, (const xmlChar*)"EXPANDED", (const xmlChar*)"false"); // Set the type xmlSetProp (xmlNode, (const xmlChar*)"TYPE", (const xmlChar*)(const_cast<IPrimitive*> (this)->getClassName ().c_str ())); // Save the properties std::map<std::string, IProperty*>::const_iterator ite = _Properties.begin (); while (ite != _Properties.end ()) { // Not a default property ? if (!ite->second->Default) { // Create new nodes xmlNodePtr propNode = xmlNewChild ( xmlNode, NULL, (const xmlChar*)"PROPERTY", NULL); xmlNodePtr nameNode = xmlNewChild ( propNode, NULL, (const xmlChar*)"NAME", NULL); xmlNodePtr textNode = xmlNewText ((const xmlChar *)(ite->first.c_str ())); xmlAddChild (nameNode, textNode); // Type const CPropertyString *str = dynamic_cast<const CPropertyString *> (ite->second); if (str) { // Set the type xmlSetProp (propNode, (const xmlChar*)"TYPE", (const xmlChar*)"string"); // Create new nodes xmlNodePtr stringNode = xmlNewChild ( propNode, NULL, (const xmlChar*)"STRING", NULL); xmlNodePtr textNode = xmlNewText ((const xmlChar *)(str->String.c_str ())); xmlAddChild (stringNode, textNode); } else { // Should be an array const CPropertyStringArray *array = dynamic_cast<const CPropertyStringArray *> (ite->second); if (array) { // Set the type xmlSetProp (propNode, (const xmlChar*)"TYPE", (const xmlChar*)"string_array"); // For each strings in the array for (uint i=0; i<array->StringArray.size (); i++) { // Create new nodes xmlNodePtr stringNode = xmlNewChild ( propNode, NULL, (const xmlChar*)"STRING", NULL); xmlNodePtr textNode = xmlNewText ((const xmlChar *)(array->StringArray[i].c_str ())); xmlAddChild (stringNode, textNode); } } else { // Should be a color const CPropertyColor *color = safe_cast<const CPropertyColor *> (ite->second); // Set the type xmlSetProp (propNode, (const xmlChar*)"TYPE", (const xmlChar*)"color"); // Create new nodes xmlNodePtr colorNode = xmlNewChild ( propNode, NULL, (const xmlChar*)"COLOR", NULL); xmlSetProp (colorNode, (const xmlChar*)"R", (const xmlChar*)toString (color->Color.R).c_str ()); xmlSetProp (colorNode, (const xmlChar*)"G", (const xmlChar*)toString (color->Color.G).c_str ()); xmlSetProp (colorNode, (const xmlChar*)"B", (const xmlChar*)toString (color->Color.B).c_str ()); xmlSetProp (colorNode, (const xmlChar*)"A", (const xmlChar*)toString (color->Color.A).c_str ()); } } } ite++; } // Save the children for (uint i=0; i<_Children.size (); i++) { // New node xmlNodePtr childNode = xmlNewChild ( xmlNode, NULL, (const xmlChar*)"CHILD", NULL); // Write it _Children[i]->write (childNode, filename); } }

---

Field Documentation

uint NLLIGO::IPrimitive::_ChildId [private]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Definition at line 317 of file primitive.h. Referenced by getChildId(), and operator=().

std::vector<IPrimitive*> NLLIGO::IPrimitive::_Children [private]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Definition at line 323 of file primitive.h. Referenced by operator=().

IPrimitive* NLLIGO::IPrimitive::_Parent [private]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Definition at line 320 of file primitive.h. Referenced by insertChild().

std::map<std::string, IProperty*> NLLIGO::IPrimitive::_Properties [private]

Add a property If the property already exist, the method does nothing and returns false. The pointer will be deleted by the primitive using the ::delete operator. Definition at line 326 of file primitive.h. Referenced by addPropertyByName(), getNumProperty(), getProperty(), getPropertyByName(), operator=(), read(), removeProperties(), removeProperty(), removePropertyByName(), and write().

bool NLLIGO::IPrimitive::Expanded

Definition at line 163 of file primitive.h. Referenced by operator=(), read(), and write().

std::string NLLIGO::IPrimitive::Layer

Definition at line 159 of file primitive.h. Referenced by NLLIGO::CPrimitives::convertPrimitive(), and operator=().

std::string NLLIGO::IPrimitive::Name

Definition at line 160 of file primitive.h. Referenced by NLLIGO::CPrimitives::convertAddPrimitive(), and operator=().

---

The documentation for this class was generated from the following files:

• primitive.h
• primitive.cpp

---