GeoProperty.h File Reference

Utility functions for manipulating Geometry Properties that conform to the geometry schema. More...

#include <Bifrost/Geometry/GeometryExport.h>
#include <Bifrost/Geometry/GeoPropertyKey.h>
#include <Bifrost/Geometry/GeometryTypes.h>
#include <Bifrost/Math/Types.h>
#include <Bifrost/Object/Object.h>
#include <Amino/Core/StringView.h>

Go to the source code of this file.

Namespaces
namespace	Bifrost
namespace	Bifrost::Geometry

Functions
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropTarget (const Bifrost::Object &object, const Bifrost::Object &geoProp)
	Get referenced counted pointer of the target of a specified geometry property. More...
Amino::String BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropTargetName (const Bifrost::Object &object, Amino::StringView geoProp)
	Get the name of the target for the specified geo property. More...
Amino::String BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropTargetName (const Bifrost::Object &geoProp)
	Get the name of the target for the specified geo property. More...
Amino::String BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getTargetComponent (const Bifrost::Object &object, Amino::StringView geoProp)
	Determines the topological component that the specified geometry property is defined over. More...
Amino::Array< Amino::String > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getTargetChain (const Bifrost::Object &object, Amino::StringView geoProp)
	Walks the target chain from the given geo property to the terminal geo component property. More...
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getComponentGeoPropPrototype ()
	Returns the prototypical component geometry property object. More...
void BIFROST_GEOMETRY_DECL	Bifrost::Geometry::populateComponentGeoProperty (Amino::uint_t elementCount, Bifrost::Object &object)
	Populate a Geometry object with the required properties to conform to the component geometry property schema. More...
bool BIFROST_GEOMETRY_DECL	Bifrost::Geometry::setElementCount (Amino::StringView component, Amino::uint_t elementCount, Bifrost::Object &object)
	Set the number of elements in a component of a geometry. More...
Amino::uint_t BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getElementCount (const Bifrost::Object &object, Amino::StringView component)
	Get the number of elements in a component of a geometry. More...
Amino::uint_t BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getElementCount (const Bifrost::Object &compGeoProp)
	Get the number of component elements in a ComponentGeoProperty object. More...
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getDataGeoPropPrototype (Amino::StringView property=Geometry::sGenericDataGeoProp)
	Returns the prototypical data geometry property object. More...
template<typename T >
void	Bifrost::Geometry::populateDataGeoProperty (T defaultValue, Bifrost::Object &object)
	Populate a Geometry object with the required properties to conform to the data geometry property schema. More...
template<typename DataType >
void	Bifrost::Geometry::populateDataGeoProperty (const DataType &defaultValue, Amino::Ptr< Amino::Array< DataType > > data, Amino::StringView target, Bifrost::Object &geoProp)
	Populate a Geometry object with the required properties to conform to the data geometry property schema. More...
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getDataGeoProperty (const Bifrost::Object &object, Amino::StringView property)
	Get a geo property from an object, with the specified name. More...
template<typename T >
Amino::Ptr< Amino::Array< T > >	Bifrost::Geometry::getDataGeoPropValues (const Bifrost::Object &object, Amino::StringView property)
	Get the actual data array from a data geometry property. More...
template<typename DataType >
bool	Bifrost::Geometry::setDataGeoPropValues (Amino::StringView property, Amino::Ptr< Amino::Array< DataType > > dataPropValues, Bifrost::Object &object)
	Sets the actual data array in a data geometry property. More...
bool BIFROST_GEOMETRY_DECL	Bifrost::Geometry::isOffsetDataGeoProp (const Bifrost::Object &object, Amino::StringView property)
	Queries if the specified property is an offset array. More...
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getRangeGeoPropPrototype ()
	Returns the prototypical range geometry property object. More...
void BIFROST_GEOMETRY_DECL	Bifrost::Geometry::populateRangeGeoProperty (Bifrost::Object &object)
	Populate a Geometry object with the required properties to conform to the range geometry property schema. More...
bool BIFROST_GEOMETRY_DECL	Bifrost::Geometry::populateRangeGeoProperty (Amino::Ptr< Amino::Array< Index > > indices, Amino::StringView target, Bifrost::Object &geoProp)
	Populate a Geometry object with the required properties to conform to the range geometry property schema. More...
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getRangeGeoProperty (const Bifrost::Object &object, Amino::StringView property)
	Get a range geo property from an object. More...
Amino::Ptr< Amino::Array< Index > > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getRangeGeoPropIndices (const Bifrost::Object &object, Amino::StringView property)
	Get the indices for the specified range geometry property. More...
Amino::Ptr< Amino::Array< Index > > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getRangeGeoPropIndices (const Bifrost::Object &rangeGeoProp)
	Get the indices for the specified range object. More...
bool BIFROST_GEOMETRY_DECL	Bifrost::Geometry::setRangeGeoPropIndices (Amino::StringView property, Amino::Ptr< Amino::Array< Index > > indices, Bifrost::Object &object)
	Get the indices for the specified range geometry property. More...
void BIFROST_GEOMETRY_DECL	Bifrost::Geometry::populateTrivialRangeIndices (size_t count, Amino::Array< Index > &indices)
	Creates a trivial indexing with the specified size. More...
Amino::String BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropRangeName (Amino::StringView geoProp)
	Gets the name of a data geo property's corresponding range geo property. More...
Amino::Array< Amino::Ptr< Bifrost::Object > > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropsByPrototype (Bifrost::Object const &object, Bifrost::Object const &prototype)
	Given a prototype, ex.: a geo property prototype (component, range, or data), return an array of objects that match the input prototype. More...
Amino::Array< Amino::Ptr< Bifrost::Object > > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropsByTarget (Bifrost::Object const &object, Amino::StringView target)
	Given a target string, return an array of geo prop objects that have that target. More...
Amino::Array< Amino::String > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropNamesByPrototype (Bifrost::Object const &object, Bifrost::Object const &prototype)
	Given a prototype, ex.: a geo property prototype (component, range, or data), return an array of property keys that match the input prototype. More...
Amino::Array< Amino::String > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropNamesByTarget (Bifrost::Object const &object, Amino::StringView target)
	Given a target string, return an array of property keys that have that target. More...
Amino::Array< Amino::String > BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getGeoPropsByName (Bifrost::Object const &object, Amino::StringView pattern)
	Given a pattern, return an array of property keys that have that pattern. More...
Amino::String BIFROST_GEOMETRY_DECL	Bifrost::Geometry::getUniqueGeoPropName (Amino::StringView propertyName, Bifrost::Object const &object)
	Given a name, return a name that is similar but unique to the specified object. More...

Detailed Description

Utility functions for manipulating Geometry Properties that conform to the geometry schema.

Definition in file GeoProperty.h.