This page has been translated automatically.
Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::Properties Class

Unigine properties. This interface provides access to Unigine property manager functions.

To use this class, include the UnigineProperties.h file.

Unigine::Properties Class

Members


virtual ~Properties ()

Virtual destructor.

static Properties * get ()

Return a pointer to the existing property manager.

Return value

Pointer to the existing property manager.

virtual int create (const char * name) const =0

Creates an empty property library.

Arguments

  • const char * name - Property library name.

Return value

1 if the property library is created successfully; otherwise, 0.

virtual int load (const char * name) const =0

Loads the property library from the file.

Arguments

  • const char * name - Property library name.

Return value

1 if the property library is loaded successfully; otherwise, 0.

virtual int save (const char * name) const =0

Saves the property library into the file.

Arguments

  • const char * name - Property library name.

Return value

1 if the property library is saved successfully; otherwise, 0.

virtual int clear (const char * name) const =0

Clears the property library by its name.

Arguments

  • const char * name - Property library name.

Return value

1 if the property library is cleared successfully; otherwise, 0.

virtual int getNumLibraries () const =0

Returns the number of loaded property libraries.

Return value

The number of loaded property libraries.

virtual const char * getLibraryName (int num) const =0

Returns the property library name.

Arguments

  • int num - Property library number.

Return value

The name of property library.

virtual int isLibraryEditable (int num) const =0

Returns the property library editable flag.

Arguments

  • int num - Property library number.

Return value

The editable flag.

virtual int isLibrary (const char * name) const =0

Checks the property library by its name.

Arguments

  • const char * name - Property library name.

Return value

1 if the property library exists; otherwise, 0.

virtual int findLibrary (const char * name) const =0

Finds the property library by its name.

Arguments

  • const char * name - Property library name.

Return value

Property library number.

virtual int getNumProperties (int library) const =0

Returns the number of library properties.

Arguments

  • int library - Library number.

Return value

The number of library properties.

virtual PropertyPtr getProperty (int library, int num) const =0

Returns the property.

Arguments

  • int library - Library number.
  • int num - Property number.

Return value

Property smart pointer.

virtual const char * getPropertyName (int library, int num) const =0

Returns the property name.

Arguments

  • int library - Library number.
  • int num - Property number.

Return value

The name of property.

virtual int isProperty (const char * name) const =0

Checks the property by its name.

Arguments

  • const char * name - Property name.

Return value

1 if the property exists; otherwise, 0.

virtual PropertyPtr findProperty (const char * name) const =0

Finds the property by its name.

Arguments

  • const char * name - Property name.

Return value

Property smart pointer.

virtual int findPropertyLibrary (const char * name) const =0

Finds the property library by property name.

Arguments

  • const char * name - Property name.

Return value

Property library number.

virtual int findPropertyLibrary (const PropertyPtr & property) const =0

Finds the property library by property name.

Arguments

  • const PropertyPtr & property - Property smart pointer.

Return value

Property library number.

virtual int findLibraryProperty (int library, const char * name) const =0

Finds the property in the specified property library.

Arguments

  • int library - Library number.
  • const char * name - Property name.

Return value

Property number.

virtual int findLibraryProperty (int library, const PropertyPtr & property) const =0

Finds the property in the specified property library.

Arguments

  • int library - Library number.
  • const PropertyPtr & property - Property smart pointer.

Return value

Property number.

virtual int cloneProperty (const char * name, const char * new_library, const char * new_name) const =0

Clones property into the specified property library.

Arguments

  • const char * name - Property name.
  • const char * new_library - New property library name.
  • const char * new_name - New property name.

Return value

1 if the property is cloned successfully; otherwise, 0.

virtual int inheritProperty (const char * name, const char * new_library, const char * new_name) const =0

Inherits property into the specified property library.

Arguments

  • const char * name - Property name.
  • const char * new_library - New property library name.
  • const char * new_name - New property name.

Return value

1 if the property is inherited successfully; otherwise, 0.

virtual int moveProperty (const char * name, const char * new_library, const char * new_name) const =0

Moves property into the specified property library..

Arguments

  • const char * name - Property name.
  • const char * new_library - New property library name.
  • const char * new_name - New property name.

Return value

1 if the property is moved successfully; otherwise,

virtual int removeProperty (const char * name) const =0

Removes property by its name.

Arguments

  • const char * name - Property name.

Return value

1 if the property is removed successfully; otherwise, 0.

virtual int replaceProperty (const char * name, const char * new_name) const =0

Replaces the specified property with a new one.

Arguments

  • const char * name - Name of the property to be replaced.
  • const char * new_name - Name of the new property

Return value

1 if the property is replaced successfully; otherwise, 0.

virtual int replaceProperty (const PropertyPtr & property, const char * new_name) const =0

Replaces the specified property with a new one.

Arguments

  • const PropertyPtr & property - Smart pointer to the property to be replaced.
  • const char * new_name - Name of the new property.

Return value

1 if the property is replaced successfully; otherwise, 0.
Last update: 2017-07-03
Build: ()