You.i Engine
IYIPropertiesSource Class Referenceabstract

Detailed Description

An interface to a class that provides key-value properties.

#include <import/YiPropertiesSource.h>

Inheritance diagram for IYIPropertiesSource:

Public Member Functions

virtual ~IYIPropertiesSource ()=default
 
virtual CYIOptional< CYIStringViewGetProperty (CYIStringView propertyName) const =0
 
bool GetProperty (CYIStringView propertyName, CYIString *pValue) const
 
virtual std::map< CYIString, CYIStringGetProperties () const =0
 
virtual void ForEachProperty (const std::function< void(const CYIString &, const CYIString &)> &action) const =0
 
virtual bool HasProperties () const =0
 

Constructor & Destructor Documentation

◆ ~IYIPropertiesSource()

virtual IYIPropertiesSource::~IYIPropertiesSource ( )
virtualdefault

Member Function Documentation

◆ ForEachProperty()

virtual void IYIPropertiesSource::ForEachProperty ( const std::function< void(const CYIString &, const CYIString &)> &  action) const
pure virtual

Executes action for each property held by this object. Each property name and property value pair is passed to action.

Implemented in CYISceneNode, CYISceneView, and CYIAEViewTemplate.

◆ GetProperties()

virtual std::map<CYIString, CYIString> IYIPropertiesSource::GetProperties ( ) const
pure virtual

Returns the map of all available properties.

Implemented in CYISceneNode, CYISceneView, and CYIAEViewTemplate.

◆ GetProperty() [1/2]

virtual CYIOptional<CYIStringView> IYIPropertiesSource::GetProperty ( CYIStringView  propertyName) const
pure virtual

Returns the value of the property identified by propertyName, or an empty optional if the property does not exist.

Note
The returned string view may become invalid if new properties are subsequently added to (or removed from) the properties source.

Implemented in CYISceneNode, CYISceneView, and CYIAEViewTemplate.

◆ GetProperty() [2/2]

bool IYIPropertiesSource::GetProperty ( CYIStringView  propertyName,
CYIString pValue 
) const
Deprecated:
This function is deprecated and may be removed in a future release. GetProperty(CYIStringView) const should be used instead.

Stores the value of a property specified by propertyName into pValue. Returns false if the property cannot be found.

◆ HasProperties()

virtual bool IYIPropertiesSource::HasProperties ( ) const
pure virtual

Returns true if this source contains at least one property.

Implemented in CYISceneNode, CYISceneView, and CYIAEViewTemplate.


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