Functions
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...

Detailed Description

Functions for manipulating Range GeoProperties.

Function Documentation

◆ getGeoPropRangeName()

Amino::String BIFROST_GEOMETRY_DECL Bifrost::Geometry::getGeoPropRangeName ( Amino::StringView geoProp )

Gets the name of a data geo property's corresponding range geo property.

Note this only returns a string name, it does not guarantee the property exists in an Object.

Parameters

[in] geoProp Geometry property name

Returns: The name of the corresponding range geo property (appends sIndexSuffix).

◆ getRangeGeoProperty()

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.

A nullptr is returned if the specified property could not be found.

Parameters

[in]	object	The object to query.
[in]	property	The name of the range geo property to return.

Returns: The range geo property, or nullptr if it could not be found.

◆ getRangeGeoPropIndices() [1/2]

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.

Parameters

[in]	object	Object on which to look for the rage geometry property indices.
[in]	property	Range geometry property name. If this name does not specify a valid range geometry property, this function will fail.

Returns: Referenced counted pointer to the array of data or nullptr if the range does not exist. The reference count secures the data access.

◆ getRangeGeoPropIndices() [2/2]

Amino::Ptr< Amino::Array< Index > > BIFROST_GEOMETRY_DECL Bifrost::Geometry::getRangeGeoPropIndices ( const Bifrost::Object & rangeGeoProp )

Get the indices for the specified range object.

Parameters

[in] rangeGeoProp The range geo property

Returns: The index array, or nullptr if it could not be found.

◆ getRangeGeoPropPrototype()

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL Bifrost::Geometry::getRangeGeoPropPrototype ( )

Returns the prototypical range geometry property object.

The returned pointer may be used in conjunction with Bifrost::Object::isA to determine if an object conforms to the range geometry property schema. The returned object may not be modified.

Returns: The range geo property prototype.

◆ populateRangeGeoProperty() [1/2]

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.

It is templated on the index array type.

Parameters

[in]	indices	The indices that map components to data. May be nullptr.
[in]	target	The target for the range.
[in,out]	geoProp	Geometry object to be populated.

Returns: true on success, false otherwise.

◆ populateRangeGeoProperty() [2/2]

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.

Parameters

[in,out] object Geometry object to be populated.

◆ populateTrivialRangeIndices()

void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateTrivialRangeIndices	(	size_t	count,
		Amino::Array< Index > &	indices
	)

Creates a trivial indexing with the specified size.

Parameters

[in]	count	The number of indices required.
[in]	indices	The index array to populate.

◆ setRangeGeoPropIndices()

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.

Parameters

[in]	property	Range geometry property name. If this name does not specify a valid range geometry property, this function will fail.
[in]	indices	The Amino::Array of indices to set on the range geometry property.
[in,out]	object	Object on which to look for the range geometry property.

Returns: true on success, false otherwise.