Bifrost Namespace Reference

Namespaces
namespace	File
namespace	FileUtils
namespace	Geometry
namespace	Math
namespace	Simulation
namespace	Version

Classes
class	Object
	An interface for dictionary-like objects. More...
class	PropertyGuard
	This class is a RAII guard for a Bifrost::Object property. More...
class	PropertyGuard< Amino::Ptr< T > >
	Specialization of PropertyGuard for Amino::Ptr<T>. More...

Functions
template<typename T >
bool	hasProperty (const Bifrost::Object &object, Amino::StringView propertyName)
	Check if an object has a property with type T and name propertyName. More...
template<typename T >
PropertyGuard< T >	createPropGuard (Bifrost::Object &object, Amino::StringView propertyName)
	Create a PropertyGuard for the given object and property name. More...
template<typename T >
PropertyGuard< Amino::Ptr< T > >	createPtrPropGuard (Bifrost::Object &object, Amino::StringView propertyName)
	Create a PropertyGuard for an Amino::Ptr<T> property. More...
Amino::MutablePtr< Object >	createObject ()
	Construct a new Object. More...
Amino::MutablePtr< Object >	createObject (std::initializer_list< Object::Property > properties)
	Construct a new Object with the given properties. More...

Function Documentation

createPropGuard()

template<typename T >

PropertyGuard< T > Bifrost::createPropGuard	(	Bifrost::Object &	object,
		Amino::StringView	propertyName
	)

Create a PropertyGuard for the given object and property name.

Parameters

[in,out]	object	The input object.
[in]	propertyName	The name of the property to extract.

Returns

A PropertyGuard RAII class that extracts the property with type T and name propertyName from object and sets the property back when the guard is destructed.

Definition at line 122 of file GeoPropertyGuard.h.

createPtrPropGuard()

template<typename T >

PropertyGuard< Amino::Ptr< T > > Bifrost::createPtrPropGuard	(	Bifrost::Object &	object,
		Amino::StringView	propertyName
	)

Create a PropertyGuard for an Amino::Ptr<T> property.

Parameters

[in,out]	object	The input object.
[in]	propertyName	The name of the property to extract.

Returns

A PropertyGuard RAII class that extracts the property with type Amino::Ptr<T> and name propertyName from object and sets the property back when the guard is destructed.

Definition at line 129 of file GeoPropertyGuard.h.

hasProperty()

template<typename T >

bool Bifrost::hasProperty	(	const Bifrost::Object &	object,
		Amino::StringView	propertyName
	)

Check if an object has a property with type T and name propertyName.

Parameters

[in]	object	The input object.
[in]	propertyName	The name of the property to check for.

Returns

true if object has a property with type T and name propertyName.

Definition at line 116 of file GeoPropertyGuard.h.

References Amino::Any::type().