Bifrost SDK
Bifrost SDK documentation
Various GeoProperty Functions

Functions

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

Functions for helping find GeoProperties.

Function Documentation

◆ getGeoPropNamesByPrototype()

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.

Parameters
[in]objectThe object that will be searched.
[in]prototypeThe object propertype that serves as search criterion.
Returns
Array of matching property keys.

◆ getGeoPropNamesByTarget()

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.

Parameters
[in]objectThe object that will be searched.
[in]targetstring that as search criterion.
Returns
Array of matching property keys.

◆ getGeoPropsByName()

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.

Parameters
[in]objectThe object that will be searched.
[in]patternstring search criterion.
Returns
Array of matching property keys.

◆ getGeoPropsByPrototype()

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.

Parameters
[in]objectThe object that will be searched.
[in]prototypeThe object propertype that serves as search criterion.
Returns
Array of matching objects.

◆ getGeoPropsByTarget()

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.

Parameters
[in]objectThe object that will be searched.
[in]targetstring that as search criterion.
Returns
Array of matching objects.

◆ getUniqueGeoPropName()

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.

Parameters
[in]propertyNameThe name to unique-ify.
[in]objectThe object to check against.
Returns
A property name that is not used by any other property in object. If the property name is already unused, then it is returned unchanged.