Component GeoProperty

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

Detailed Description

Functions for manipulating Component GeoProperties.

Function Documentation

getComponentGeoPropPrototype()

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL Bifrost::Geometry::getComponentGeoPropPrototype

(

)

Returns the prototypical component geometry property object.

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

Returns

The component geo property prototype.

getElementCount() [1/2]

Amino::uint_t BIFROST_GEOMETRY_DECL Bifrost::Geometry::getElementCount

(

const Bifrost::Object &

compGeoProp

)

Get the number of component elements in a ComponentGeoProperty object.

Parameters

[in]

compGeoProp

Component Geo Property to query.

Returns

The number of elements or zero on error.

getElementCount() [2/2]

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.

For example, to get the number of points in a points geometry:

auto pointCount = getElementCount(pointsGeo, sPointComp);

Parameters

[in]	object	Geometry object which contains the ComponentGeoProperty.
[in]	component	Name of the component geometry property.

Returns

The number of elements or zero on error.

populateComponentGeoProperty()

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.

Parameters

[in]	elementCount	The number of elements (stored).
[in,out]	object	Object to be populated.

setElementCount()

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.

For example, to set the number of points to 10, in a points geometry:

setElementCount(sPointComp, 10, pointsGeo);

Parameters

[in]	component	Name of the component geometry property.
[in]	elementCount	Number of elements (stored).
[in,out]	object	Object that contains the geometry property component that will be modified.

Returns

true on success, false otherwise.