#include <BLI_serialize.hh>

Inherits blender::io::serialize::Value.

Public Types
using	Item = std::pair<std::string, std::shared_ptr<Value>>
using	Lookup = Map<std::string, std::shared_ptr<Value>>

Public Member Functions
	DictionaryValue ()
Lookup	create_lookup () const
const std::shared_ptr< Value > *	lookup (StringRef key) const
std::optional< StringRefNull >	lookup_str (StringRef key) const
std::optional< int64_t >	lookup_int (StringRef key) const
std::optional< double >	lookup_double (StringRef key) const
const DictionaryValue *	lookup_dict (StringRef key) const
const ArrayValue *	lookup_array (StringRef key) const
Span< Item >	elements () const
void	append (std::string key, std::shared_ptr< Value > value)
void	append_int (std::string key, int64_t value)
void	append_double (std::string key, double value)
void	append_str (std::string key, std::string value)
std::shared_ptr< DictionaryValue >	append_dict (std::string key)
std::shared_ptr< ArrayValue >	append_array (std::string key)
Public Member Functions inherited from blender::io::serialize::Value
	Value ()=delete
virtual	~Value ()=default
eValueType	type () const
const StringValue *	as_string_value () const
const IntValue *	as_int_value () const
const DoubleValue *	as_double_value () const
const BooleanValue *	as_boolean_value () const
const EnumValue *	as_enum_value () const
const ArrayValue *	as_array_value () const
const DictionaryValue *	as_dictionary_value () const

Additional Inherited Members
Protected Member Functions inherited from blender::io::serialize::Value
	Value (eValueType type)

Detailed Description

Object is a key-value container where the key must be a std::string. Internally it is stored in a blender::Vector to ensure the order of keys.

Definition at line 234 of file BLI_serialize.hh.

Member Typedef Documentation

◆ Item

using blender::io::serialize::DictionaryValue::Item = std::pair<std::string, std::shared_ptr<Value>>

Elements are stored as an key value pair. The value is a shared pointer so it can be shared when using DictionaryValue::create_lookup.

Definition at line 240 of file BLI_serialize.hh.

◆ Lookup

using blender::io::serialize::DictionaryValue::Lookup = Map<std::string, std::shared_ptr<Value>>

Definition at line 241 of file BLI_serialize.hh.

Constructor & Destructor Documentation

◆ DictionaryValue()

blender::io::serialize::DictionaryValue::DictionaryValue ( )

inline

Definition at line 247 of file BLI_serialize.hh.

References blender::io::serialize::Value::Value().

Referenced by lookup_dict().

Member Function Documentation

◆ append()

void blender::io::serialize::DictionaryValue::append	(	std::string	key,
		std::shared_ptr< Value >	value )

Definition at line 321 of file serialize.cc.

References blender::io::serialize::ArrayValue::append().

Referenced by append_array(), append_dict(), append_double(), append_int(), append_str(), blender::bke::bake::serialize_bake_item(), and blender::bke::bake::serialize_curves_geometry().

◆ append_array()

std::shared_ptr< ArrayValue > blender::io::serialize::DictionaryValue::append_array ( std::string key )

Definition at line 348 of file serialize.cc.

References append().

Referenced by blender::bke::bake::serialize_bake_item().

◆ append_dict()

std::shared_ptr< DictionaryValue > blender::io::serialize::DictionaryValue::append_dict ( std::string key )

Definition at line 341 of file serialize.cc.

References append().

Referenced by blender::bke::bake::serialize_bake(), and blender::bke::bake::serialize_bake_item().

◆ append_double()

void blender::io::serialize::DictionaryValue::append_double	(	std::string	key,
		double	value )

Definition at line 331 of file serialize.cc.

References append().

◆ append_int()

void blender::io::serialize::DictionaryValue::append_int	(	std::string	key,
		int64_t	value )

Definition at line 326 of file serialize.cc.

References append().

Referenced by blender::bke::bake::serialize_bake(), blender::bke::bake::serialize_curves_geometry(), and blender::io::serialize::json::testing::TEST().

◆ append_str()

void blender::io::serialize::DictionaryValue::append_str	(	std::string	key,
		std::string	value )

Definition at line 336 of file serialize.cc.

References append().

Referenced by blender::bke::bake::serialize_bake_item().

◆ create_lookup()

DictionaryValue::Lookup blender::io::serialize::DictionaryValue::create_lookup ( ) const

Return a lookup map to quickly lookup by key.

The lookup is owned by the caller.

Definition at line 256 of file serialize.cc.

References result.

◆ elements()

Span< Item > blender::io::serialize::DictionaryValue::elements ( ) const

inline

Definition at line 262 of file BLI_serialize.hh.

Referenced by blender::io::serialize::convert_to_json(), and blender::bke::bake::deserialize_bake().

◆ lookup()

const std::shared_ptr< Value > * blender::io::serialize::DictionaryValue::lookup ( StringRef key ) const

Definition at line 265 of file serialize.cc.

Referenced by blender::ed::asset::index::init_indexer_entry_from_value(), lookup_array(), lookup_dict(), lookup_double(), lookup_int(), and lookup_str().

◆ lookup_array()

const ArrayValue * blender::io::serialize::DictionaryValue::lookup_array ( StringRef key ) const

Definition at line 313 of file serialize.cc.

References lookup().

Referenced by blender::ed::asset::index::init_indexer_entries_from_value(), blender::ed::asset::index::init_indexer_entry_from_value(), blender::bke::bake::try_load_curves(), blender::bke::bake::try_load_curves_geometry(), blender::bke::bake::try_load_grease_pencil(), blender::bke::bake::try_load_instances(), blender::bke::bake::try_load_mesh(), and blender::bke::bake::try_load_pointcloud().

◆ lookup_dict()

const DictionaryValue * blender::io::serialize::DictionaryValue::lookup_dict ( StringRef key ) const

Definition at line 305 of file serialize.cc.

References DictionaryValue(), and lookup().

Referenced by blender::bke::bake::deserialize_bake(), blender::bke::bake::deserialize_bake_item(), blender::bke::bake::load_attributes(), blender::bke::bake::try_load_curves(), blender::bke::bake::try_load_curves_geometry(), blender::bke::bake::try_load_grease_pencil(), blender::bke::bake::try_load_instances(), blender::bke::bake::try_load_mesh(), and blender::bke::bake::try_load_pointcloud().

◆ lookup_double()

std::optional< double > blender::io::serialize::DictionaryValue::lookup_double ( StringRef key ) const

Definition at line 295 of file serialize.cc.

References lookup().

◆ lookup_int()

std::optional< int64_t > blender::io::serialize::DictionaryValue::lookup_int ( StringRef key ) const

Definition at line 285 of file serialize.cc.

References lookup().

Referenced by blender::bke::bake::BlobSlice::deserialize(), blender::bke::bake::deserialize_bake(), blender::ed::asset::index::AssetIndex::get_version(), blender::bke::bake::try_load_curves_geometry(), blender::bke::bake::try_load_instances(), blender::bke::bake::try_load_mesh(), and blender::bke::bake::try_load_pointcloud().

◆ lookup_str()

std::optional< StringRefNull > blender::io::serialize::DictionaryValue::lookup_str ( StringRef key ) const

Definition at line 275 of file serialize.cc.

References blender::io::serialize::Value::as_string_value(), and lookup().

Referenced by blender::bke::bake::BlobSlice::deserialize(), blender::bke::bake::deserialize_bake_item(), blender::ed::asset::index::init_indexer_entry_from_value(), blender::bke::bake::read_blob_raw_data_with_endian(), and blender::bke::bake::try_load_grease_pencil().

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Item

◆ Lookup

Constructor & Destructor Documentation

◆ DictionaryValue()

Member Function Documentation

◆ append()

◆ append_array()

◆ append_dict()

◆ append_double()

◆ append_int()

◆ append_str()

◆ create_lookup()

◆ elements()

◆ lookup()

◆ lookup_array()

◆ lookup_dict()

◆ lookup_double()

◆ lookup_int()

◆ lookup_str()