Namespaces
namespace	Common

namespace	Mesh

namespace	Query

namespace	Transform

Classes
class	DataGeoPropertyGuard
	This class is a RAII guard for a Data geo property. More...

class	GeoValidator
	This is the base class for validating geometry. More...

class	InstancesValidator
	This class validates instances objects have the correct structure and valid indexing. More...

class	MeshValidator
	This class validates mesh objects have the correct structure and valid indexing. More...

class	PointCloudValidator
	This class validates point cloud objects have the correct structure and valid indexing. More...

class	RangeGeoPropertyGuard
	This class is a RAII guard for a Range geo property. More...

class	StrandValidator
	This class validates strand objects have the correct structure and valid indexing. More...

class	VolumeValidator
	This class validates volume objects have the correct structure. More...

Typedefs
using	Index = Amino::uint_t

Functions
template<typename OStream >
void	debugDump (OStream &os, Bifrost::Object const &object, size_t sampleSize=10)

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	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	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	getGeoPropTargetName (const Bifrost::Object &geoProp)
	Get the name of the target for the specified geo property. More...

Amino::String BIFROST_GEOMETRY_DECL	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	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	getComponentGeoPropPrototype ()
	Returns the prototypical component geometry property object. More...

void BIFROST_GEOMETRY_DECL	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	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	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	getElementCount (const Bifrost::Object &compGeoProp)
	Get the number of component elements in a ComponentGeoProperty object. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getDataGeoPropPrototype (Amino::StringView property=Geometry::sGenericDataGeoProp)
	Returns the prototypical data geometry property object. More...

template<typename T >
void	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	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	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 > >	getDataGeoPropValues (const Bifrost::Object &object, Amino::StringView property)
	Get the actual data array from a data geometry property. More...

template<typename DataType >
bool	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	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	getRangeGeoPropPrototype ()
	Returns the prototypical range geometry property object. More...

void BIFROST_GEOMETRY_DECL	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	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	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	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	getRangeGeoPropIndices (const Bifrost::Object &rangeGeoProp)
	Get the indices for the specified range object. More...

bool BIFROST_GEOMETRY_DECL	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	populateTrivialRangeIndices (size_t count, Amino::Array< Index > &indices)
	Creates a trivial indexing with the specified size. More...

Amino::String BIFROST_GEOMETRY_DECL	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	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	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	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	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	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	getUniqueGeoPropName (Amino::StringView propertyName, Bifrost::Object const &object)
	Given a name, return a name that is similar but unique to the specified object. More...

template<typename T >
bool	hasDataGeoProperty (const Bifrost::Object &geometry, Amino::StringView property)
	Check if a geometry object has a valid geo property with type `T` and name `property`. More...

template<typename T >
DataGeoPropertyGuard< T >	createDataGeoPropGuard (Bifrost::Object &geometry, Amino::StringView propertyName)
	Create a DataGeoPropertyGuard for the specified geo property. More...

BIFROST_GEOMETRY_DECL bool	hasRangeGeoProperty (const Bifrost::Object &geometry, Amino::StringView property)
	Check if a geometry object has a valid Range geo property with name `property`. More...

BIFROST_GEOMETRY_DECL RangeGeoPropertyGuard	createRangeGeoPropGuard (Bifrost::Object &geometry, Amino::StringView propertyName)
	Create a RangeGeoPropertyGuard for the specified range geo property. More...

BIFROST_GEOMETRY_DECL Amino::Ptr< Amino::Array< Amino::Ptr< Bifrost::Object > > >	getGeometryTypes ()
	Return a list of geometry prototypes, ordered from most to least specific. Can be used to find the type of an object, for example using the helper function Bifrost::Geometry::resolveType. More...

template<typename Prototypes >
decltype(auto)	findPrototype (Bifrost::Object const &obj, Prototypes const &prototypes)
	Finds the first prototype in the given prototypes such that the given object satisfies this prototype. More...

Common::GeometryType	resolveType (Bifrost::Object const &obj)
	Determine the type of an object. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getVolumePrototype ()
	Returns the prototypical volume object. More...

void BIFROST_GEOMETRY_DECL	populateVolume (Bifrost::Object &object)
	Populate an object with the required properties to conform to the volume geometry schema. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getLevelSetPrototype ()
	Returns the prototypical level set object. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getFogVolumePrototype ()
	Returns the prototypical fog volume object. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getFlipLiquidPrototype ()
	Returns the prototypical liquid set object. More...

void BIFROST_GEOMETRY_DECL	populateFlipLiquid (Bifrost::Object &object)
	Populate an object with the required properties to conform to the liquid geometry schema. More...

void BIFROST_GEOMETRY_DECL	populateLevelSet (Bifrost::Object &object)
	Populate an object with the required properties to conform to the level set geometry schema. More...

void BIFROST_GEOMETRY_DECL	populateFogVolume (Bifrost::Object &object)
	Populate an object with the required properties to conform to the fog volume geometry schema. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getPointCloudPrototype ()
	Returns the prototypical point cloud object. More...

void BIFROST_GEOMETRY_DECL	populatePointCloud (Bifrost::Object &object)
	Populate an object with the required properties to conform to the point cloud geometry schema. More...

bool BIFROST_GEOMETRY_DECL	populatePointCloud (Amino::Ptr< Amino::Array< Bifrost::Math::float3 > > position, Bifrost::Object &object)
	Populate an object with the required properties to conform to the point cloud geometry schema. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getStrandPrototype ()
	Returns the prototypical strand object. More...

void BIFROST_GEOMETRY_DECL	populateStrand (Bifrost::Object &object)
	Populate an object with the required properties to conform to the strand geometry schema. More...

bool BIFROST_GEOMETRY_DECL	populateStrand (Amino::Ptr< Amino::Array< Bifrost::Math::float3 > > positions, Amino::Ptr< Amino::Array< Bifrost::Geometry::Index > > strandOffsets, Bifrost::Object &object)
	Populate an object with the required properties to conform to the strand geometry schema. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getMeshPrototype ()
	Returns the prototypical mesh object. More...

void BIFROST_GEOMETRY_DECL	populateMesh (Bifrost::Object &object)
	Populate an object with the required properties to conform to the Mesh geometry schema. More...

bool BIFROST_GEOMETRY_DECL	populateMesh (Amino::Ptr< Amino::Array< Bifrost::Math::float3 > > positions, Amino::Ptr< Amino::Array< Bifrost::Geometry::Index > > face_vertices, Amino::Ptr< Amino::Array< Bifrost::Geometry::Index > > face_offsets, Bifrost::Object &object)
	Populate an object with the required properties to conform to the Mesh geometry schema. More...

void BIFROST_GEOMETRY_DECL	populateCubeMesh (float width, Bifrost::Object &object)
	Populate an object with the properties and values required to define a six-sided cube mesh. More...

void BIFROST_GEOMETRY_DECL	populateSphereMesh (float radius, Bifrost::Object &object)
	Populate an object with the properties of a mesh sphere. More...

void BIFROST_GEOMETRY_DECL	populatePlaneMesh (float width, unsigned subdivisions, Bifrost::Object &object)
	Populate an object with the properties and values required to define a unit plane with the requested subdivisions on the X and Z axes. More...

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL	getInstancesPrototype ()
	Returns the prototypical Instances object. More...

void BIFROST_GEOMETRY_DECL	populateInstances (Bifrost::Object &object)
	Populate an object with the required properties to conform to the Instances schema. More...

void BIFROST_GEOMETRY_DECL	clearGeometryPrototypes ()
	clear internal geometry structures kept as prototypes More...

GeoValidator::Status BIFROST_GEOMETRY_DECL	validateMesh (const Bifrost::Object &in_object)
	Convenience function to validate the specified object with a Bifrost::Geometry::MeshValidator. More...

Variables
BIFROST_GEOMETRY_DECL Amino::String const	sNullString

BIFROST_GEOMETRY_DECL Amino::String const	sDccName

BIFROST_GEOMETRY_DECL Amino::String const	sComponentTagSuffix

BIFROST_GEOMETRY_DECL Amino::String const	sComponentSuffix

BIFROST_GEOMETRY_DECL Amino::String const	sComponentTagPrefix_point

BIFROST_GEOMETRY_DECL Amino::String const	sComponentTagPrefix_face

BIFROST_GEOMETRY_DECL Amino::String const	sCount

BIFROST_GEOMETRY_DECL Amino::String const	sTarget

BIFROST_GEOMETRY_DECL Amino::String const	sData

BIFROST_GEOMETRY_DECL Amino::String const	sDependsOn

BIFROST_GEOMETRY_DECL Amino::String const	sDefault

BIFROST_GEOMETRY_DECL Amino::String const	sInterp

BIFROST_GEOMETRY_DECL Amino::String const	sOffsetSuffix

BIFROST_GEOMETRY_DECL Amino::String const	sIndices

BIFROST_GEOMETRY_DECL Amino::String const	sIndexSuffix

BIFROST_GEOMETRY_DECL Amino::String const	sPointComp

BIFROST_GEOMETRY_DECL Amino::String const	sFaceComp

BIFROST_GEOMETRY_DECL Amino::String const	sFaceVertexComp

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelComp

BIFROST_GEOMETRY_DECL Amino::String const	sStrandComp

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelPosition

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFogDensity

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelMassDensity

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSignedDistance

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelDepth

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelDetailSize

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelAcceleration

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelTemperature

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelIgnitionTemperature

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelPointRadius

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelDegreeOfFreedom

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelVorticity

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelExpansionRate

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFogDensitySignedDistance

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFlameLevelSet

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelCombustionRate

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFlameSpeed

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelRefinement

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSignificance

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSamplingError

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSootEmission

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelCombustionMask

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSootOxidationMask

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuel

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuelPropane

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuelEthane

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuelButane

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuelMethane

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuelPropylene

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuelPropyne

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFuelPropadiene

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelGasCarbonDioxide

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelGasNitrogen

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelGasOxygen

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelGasVapor

BIFROST_GEOMETRY_DECL Amino::String const	sPointId

BIFROST_GEOMETRY_DECL Amino::String const	sPointPassthroughId

BIFROST_GEOMETRY_DECL Amino::String const	sPointSourceId

BIFROST_GEOMETRY_DECL Amino::String const	sPointDroplet

BIFROST_GEOMETRY_DECL Amino::String const	sPointSignedAirLiquidDistance

BIFROST_GEOMETRY_DECL Amino::String const	sPointStickinessBandwidth

BIFROST_GEOMETRY_DECL Amino::String const	sPointStickinessStrength

BIFROST_GEOMETRY_DECL Amino::String const	sPointViscosity

BIFROST_GEOMETRY_DECL Amino::String const	sPointVoxelTileTree

BIFROST_GEOMETRY_DECL Amino::String const	sPointExpansionRate

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelColliderVelocity

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelFlipVelocity

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelPressure

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelRefinementNearColliders

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSignedAirLiquidDistance

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSignedCoarsenRefineDistance

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSignedColliderDistance

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelSignedGuideDistance

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelStickinessBandwidth

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelStickinessStrength

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelChurn

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelPointCount

BIFROST_GEOMETRY_DECL Amino::String const	sPointColor

BIFROST_GEOMETRY_DECL Amino::String const	sPointNormal

BIFROST_GEOMETRY_DECL Amino::String const	sPointOrientation

BIFROST_GEOMETRY_DECL Amino::String const	sPointPosition

BIFROST_GEOMETRY_DECL Amino::String const	sPointSize

BIFROST_GEOMETRY_DECL Amino::String const	sPointAge

BIFROST_GEOMETRY_DECL Amino::String const	sPointSpin

BIFROST_GEOMETRY_DECL Amino::String const	sPointMass

BIFROST_GEOMETRY_DECL Amino::String const	sPointInstanceId

BIFROST_GEOMETRY_DECL Amino::String const	sPointKinematic

BIFROST_GEOMETRY_DECL Amino::String const	sPointFriction

BIFROST_GEOMETRY_DECL Amino::String const	sPointUV

BIFROST_GEOMETRY_DECL Amino::String const	sPointVelocity

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelVelocity

BIFROST_GEOMETRY_DECL Amino::String const	sStrandOffset

BIFROST_GEOMETRY_DECL Amino::String const	sPointStrandIndex

BIFROST_GEOMETRY_DECL Amino::String const	sPointTangent

BIFROST_GEOMETRY_DECL Amino::String const	sPointRatio

BIFROST_GEOMETRY_DECL Amino::String const	sPointLength

BIFROST_GEOMETRY_DECL Amino::String const	sStrandLength

BIFROST_GEOMETRY_DECL Amino::String const	sFaceCenter

BIFROST_GEOMETRY_DECL Amino::String const	sFaceNormal

BIFROST_GEOMETRY_DECL Amino::String const	sFaceOffset

BIFROST_GEOMETRY_DECL Amino::String const	sFaceUV

BIFROST_GEOMETRY_DECL Amino::String const	sFaceVertex

BIFROST_GEOMETRY_DECL Amino::String const	sFaceVertexNormal

BIFROST_GEOMETRY_DECL Amino::String const	sFaceVertexUV

BIFROST_GEOMETRY_DECL Amino::String const	sVoxelTileTree

BIFROST_GEOMETRY_DECL Amino::String const	sInstanceShape

BIFROST_GEOMETRY_DECL Amino::String const	sInstanceShapes

BIFROST_GEOMETRY_DECL Amino::String const	sRenderSettings

BIFROST_GEOMETRY_DECL Amino::String const	sMaterialSurface

BIFROST_GEOMETRY_DECL Amino::String const	sMaterialDisplacement

BIFROST_GEOMETRY_DECL Amino::String const	sMaterialVolume

BIFROST_GEOMETRY_DECL Amino::String const	sMaterialReferenceID

BIFROST_GEOMETRY_DECL Amino::String const	sOperatorReferenceID

BIFROST_GEOMETRY_DECL Amino::String const	sOperators

BIFROST_GEOMETRY_DECL Amino::String const	sGenericDataGeoProp

BIFROST_GEOMETRY_DECL Amino::String const	sAcceleratorGeo

BIFROST_GEOMETRY_DECL Amino::String const	sAcceleratorGrid

BIFROST_GEOMETRY_DECL Amino::String const	sAcceleratorComponent

BIFROST_GEOMETRY_DECL Amino::String const	sImageDisplacement

BIFROST_GEOMETRY_DECL Amino::String const	sImageVelocity

BIFROST_GEOMETRY_DECL Amino::String const	sFaceSourceIndex

BIFROST_GEOMETRY_DECL Amino::String const	sPointSourceIndex

BIFROST_GEOMETRY_DECL Amino::String const	sPointSourceWeight

BIFROST_GEOMETRY_DECL Amino::String const	sPointSourceOffsets

BIFROST_GEOMETRY_DECL Amino::String const	sFaceVertexSourceIndex

BIFROST_GEOMETRY_DECL Amino::String const	sFaceVertexSourceWeight

BIFROST_GEOMETRY_DECL Amino::String const	sFaceVertexSourceOffsets

BIFROST_GEOMETRY_DECL const Geometry::Index	kInvalidIndex

BIFROST_GEOMETRY_DECL const Geometry::Index	kDeletedElement

Typedef Documentation

◆ Index

using Bifrost::Geometry::Index = typedef Amino::uint_t

Definition at line 201 of file GeoPropertyKey.h.

Function Documentation

◆ createDataGeoPropGuard()

template<typename T >

DataGeoPropertyGuard< T > Bifrost::Geometry::createDataGeoPropGuard	(	Bifrost::Object &	geometry,
		Amino::StringView	propertyName
	)

Create a DataGeoPropertyGuard for the specified geo property.

Parameters

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

Template Parameters

T	The data type of the geo property.

Returns: A DataGeoPropertyGuard RAII class that extracts the geometry property with type T and name propertyName from object and sets the property back when the guard is destructed. If the geo property does not exist in the geometry, the returned guard's boolean cast operator will return false.

Definition at line 409 of file GeoPropertyGuard.h.

◆ createRangeGeoPropGuard()

BIFROST_GEOMETRY_DECL RangeGeoPropertyGuard Bifrost::Geometry::createRangeGeoPropGuard	(	Bifrost::Object &	geometry,
		Amino::StringView	propertyName
	)

Create a RangeGeoPropertyGuard for the specified range geo property.

Parameters

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

Returns: A RangeGeoPropertyGuard RAII class that extracts the geometry property with type T and name propertyName from object and sets the property back when the guard is destructed. If the geo property does not exist in the geometry, the returned guard's boolean cast operator will return false.

◆ hasDataGeoProperty()

template<typename T >

bool Bifrost::Geometry::hasDataGeoProperty	(	const Bifrost::Object &	geometry,
		Amino::StringView	property
	)

Check if a geometry object has a valid geo property with type T and name property.

Parameters

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

Template Parameters

T	The data type of the geo property.

Returns: true if geometry has a valid geometry property with type T and name property.

Definition at line 301 of file GeoPropertyGuard.h.

References getDataGeoProperty().

◆ hasRangeGeoProperty()

BIFROST_GEOMETRY_DECL bool Bifrost::Geometry::hasRangeGeoProperty	(	const Bifrost::Object &	geometry,
		Amino::StringView	property
	)

Check if a geometry object has a valid Range geo property with name property.

Parameters

[in]	geometry	The input geometry.
[in]	property	The name of the Range geo property to check for.

Returns: true if geometry has a valid Range geo property with name property.

◆ validateMesh()

GeoValidator::Status BIFROST_GEOMETRY_DECL Bifrost::Geometry::validateMesh ( const Bifrost::Object & in_object )

Convenience function to validate the specified object with a Bifrost::Geometry::MeshValidator.

Parameters

[in] in_object Mesh geometry object to be validated

Returns: The status of the validation.

Variable Documentation

◆ kDeletedElement

BIFROST_GEOMETRY_DECL const Geometry::Index Bifrost::Geometry::kDeletedElement

extern

◆ kInvalidIndex

BIFROST_GEOMETRY_DECL const Geometry::Index Bifrost::Geometry::kInvalidIndex

extern

◆ sAcceleratorComponent

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sAcceleratorComponent

extern

◆ sAcceleratorGeo

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sAcceleratorGeo

extern

◆ sAcceleratorGrid

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sAcceleratorGrid

extern

◆ sComponentSuffix

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sComponentSuffix

extern

◆ sComponentTagPrefix_face

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sComponentTagPrefix_face

extern

◆ sComponentTagPrefix_point

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sComponentTagPrefix_point

extern

◆ sComponentTagSuffix

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sComponentTagSuffix

extern

◆ sCount

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sCount

extern

◆ sData

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sData

extern

Referenced by getDataGeoPropValues(), populateDataGeoProperty(), and setDataGeoPropValues().

◆ sDccName

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sDccName

extern

◆ sDefault

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sDefault

extern

Referenced by populateDataGeoProperty().

◆ sDependsOn

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sDependsOn

extern

Referenced by populateDataGeoProperty().

◆ sFaceCenter

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceCenter

extern

◆ sFaceComp

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceComp

extern

◆ sFaceNormal

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceNormal

extern

◆ sFaceOffset

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceOffset

extern

◆ sFaceSourceIndex

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceSourceIndex

extern

◆ sFaceUV

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceUV

extern

◆ sFaceVertex

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceVertex

extern

◆ sFaceVertexComp

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceVertexComp

extern

◆ sFaceVertexNormal

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceVertexNormal

extern

◆ sFaceVertexSourceIndex

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceVertexSourceIndex

extern

◆ sFaceVertexSourceOffsets

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceVertexSourceOffsets

extern

◆ sFaceVertexSourceWeight

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceVertexSourceWeight

extern

◆ sFaceVertexUV

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sFaceVertexUV

extern

◆ sGenericDataGeoProp

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sGenericDataGeoProp

extern

◆ sImageDisplacement

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sImageDisplacement

extern

◆ sImageVelocity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sImageVelocity

extern

◆ sIndexSuffix

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sIndexSuffix

extern

◆ sIndices

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sIndices

extern

◆ sInstanceShape

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sInstanceShape

extern

◆ sInstanceShapes

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sInstanceShapes

extern

◆ sInterp

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sInterp

extern

Referenced by populateDataGeoProperty().

◆ sMaterialDisplacement

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sMaterialDisplacement

extern

◆ sMaterialReferenceID

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sMaterialReferenceID

extern

◆ sMaterialSurface

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sMaterialSurface

extern

◆ sMaterialVolume

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sMaterialVolume

extern

◆ sNullString

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sNullString

extern

Referenced by populateDataGeoProperty().

◆ sOffsetSuffix

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sOffsetSuffix

extern

◆ sOperatorReferenceID

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sOperatorReferenceID

extern

◆ sOperators

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sOperators

extern

◆ sPointAge

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointAge

extern

◆ sPointColor

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointColor

extern

◆ sPointComp

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointComp

extern

◆ sPointDroplet

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointDroplet

extern

◆ sPointExpansionRate

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointExpansionRate

extern

◆ sPointFriction

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointFriction

extern

◆ sPointId

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointId

extern

◆ sPointInstanceId

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointInstanceId

extern

◆ sPointKinematic

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointKinematic

extern

◆ sPointLength

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointLength

extern

◆ sPointMass

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointMass

extern

◆ sPointNormal

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointNormal

extern

◆ sPointOrientation

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointOrientation

extern

◆ sPointPassthroughId

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointPassthroughId

extern

◆ sPointPosition

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointPosition

extern

◆ sPointRatio

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointRatio

extern

◆ sPointSignedAirLiquidDistance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointSignedAirLiquidDistance

extern

◆ sPointSize

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointSize

extern

◆ sPointSourceId

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointSourceId

extern

◆ sPointSourceIndex

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointSourceIndex

extern

◆ sPointSourceOffsets

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointSourceOffsets

extern

◆ sPointSourceWeight

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointSourceWeight

extern

◆ sPointSpin

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointSpin

extern

◆ sPointStickinessBandwidth

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointStickinessBandwidth

extern

◆ sPointStickinessStrength

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointStickinessStrength

extern

◆ sPointStrandIndex

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointStrandIndex

extern

◆ sPointTangent

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointTangent

extern

◆ sPointUV

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointUV

extern

◆ sPointVelocity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointVelocity

extern

◆ sPointViscosity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointViscosity

extern

◆ sPointVoxelTileTree

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sPointVoxelTileTree

extern

◆ sRenderSettings

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sRenderSettings

extern

◆ sStrandComp

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sStrandComp

extern

◆ sStrandLength

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sStrandLength

extern

◆ sStrandOffset

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sStrandOffset

extern

◆ sTarget

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sTarget

extern

Referenced by populateDataGeoProperty().

◆ sVoxelAcceleration

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelAcceleration

extern

◆ sVoxelChurn

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelChurn

extern

◆ sVoxelColliderVelocity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelColliderVelocity

extern

◆ sVoxelCombustionMask

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelCombustionMask

extern

◆ sVoxelCombustionRate

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelCombustionRate

extern

◆ sVoxelComp

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelComp

extern

◆ sVoxelDegreeOfFreedom

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelDegreeOfFreedom

extern

◆ sVoxelDepth

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelDepth

extern

◆ sVoxelDetailSize

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelDetailSize

extern

◆ sVoxelExpansionRate

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelExpansionRate

extern

◆ sVoxelFlameLevelSet

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFlameLevelSet

extern

◆ sVoxelFlameSpeed

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFlameSpeed

extern

◆ sVoxelFlipVelocity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFlipVelocity

extern

◆ sVoxelFogDensity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFogDensity

extern

◆ sVoxelFogDensitySignedDistance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFogDensitySignedDistance

extern

◆ sVoxelFuel

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuel

extern

◆ sVoxelFuelButane

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuelButane

extern

◆ sVoxelFuelEthane

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuelEthane

extern

◆ sVoxelFuelMethane

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuelMethane

extern

◆ sVoxelFuelPropadiene

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuelPropadiene

extern

◆ sVoxelFuelPropane

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuelPropane

extern

◆ sVoxelFuelPropylene

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuelPropylene

extern

◆ sVoxelFuelPropyne

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelFuelPropyne

extern

◆ sVoxelGasCarbonDioxide

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelGasCarbonDioxide

extern

◆ sVoxelGasNitrogen

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelGasNitrogen

extern

◆ sVoxelGasOxygen

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelGasOxygen

extern

◆ sVoxelGasVapor

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelGasVapor

extern

◆ sVoxelIgnitionTemperature

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelIgnitionTemperature

extern

◆ sVoxelMassDensity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelMassDensity

extern

◆ sVoxelPointCount

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelPointCount

extern

◆ sVoxelPointRadius

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelPointRadius

extern

◆ sVoxelPosition

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelPosition

extern

◆ sVoxelPressure

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelPressure

extern

◆ sVoxelRefinement

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelRefinement

extern

◆ sVoxelRefinementNearColliders

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelRefinementNearColliders

extern

◆ sVoxelSamplingError

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSamplingError

extern

◆ sVoxelSignedAirLiquidDistance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSignedAirLiquidDistance

extern

◆ sVoxelSignedCoarsenRefineDistance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSignedCoarsenRefineDistance

extern

◆ sVoxelSignedColliderDistance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSignedColliderDistance

extern

◆ sVoxelSignedDistance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSignedDistance

extern

◆ sVoxelSignedGuideDistance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSignedGuideDistance

extern

◆ sVoxelSignificance

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSignificance

extern

◆ sVoxelSootEmission

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSootEmission

extern

◆ sVoxelSootOxidationMask

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelSootOxidationMask

extern

◆ sVoxelStickinessBandwidth

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelStickinessBandwidth

extern

◆ sVoxelStickinessStrength

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelStickinessStrength

extern

◆ sVoxelTemperature

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelTemperature

extern

◆ sVoxelTileTree

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelTileTree

extern

◆ sVoxelVelocity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelVelocity

extern

◆ sVoxelVorticity

BIFROST_GEOMETRY_DECL Amino::String const Bifrost::Geometry::sVoxelVorticity

extern

Namespaces

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ Index

Function Documentation

◆ createDataGeoPropGuard()

◆ createRangeGeoPropGuard()

◆ hasDataGeoProperty()

◆ hasRangeGeoProperty()

◆ validateMesh()

Variable Documentation

◆ kDeletedElement

◆ kInvalidIndex

◆ sAcceleratorComponent

◆ sAcceleratorGeo

◆ sAcceleratorGrid

◆ sComponentSuffix

◆ sComponentTagPrefix_face

◆ sComponentTagPrefix_point

◆ sComponentTagSuffix

◆ sCount

◆ sData

◆ sDccName

◆ sDefault

◆ sDependsOn

◆ sFaceCenter

◆ sFaceComp

◆ sFaceNormal

◆ sFaceOffset

◆ sFaceSourceIndex

◆ sFaceUV

◆ sFaceVertex

◆ sFaceVertexComp

◆ sFaceVertexNormal

◆ sFaceVertexSourceIndex

◆ sFaceVertexSourceOffsets

◆ sFaceVertexSourceWeight

◆ sFaceVertexUV

◆ sGenericDataGeoProp

◆ sImageDisplacement

◆ sImageVelocity

◆ sIndexSuffix

◆ sIndices

◆ sInstanceShape

◆ sInstanceShapes

◆ sInterp

◆ sMaterialDisplacement

◆ sMaterialReferenceID

◆ sMaterialSurface

◆ sMaterialVolume

◆ sNullString

◆ sOffsetSuffix

◆ sOperatorReferenceID

◆ sOperators

◆ sPointAge

◆ sPointColor

◆ sPointComp

◆ sPointDroplet

◆ sPointExpansionRate

◆ sPointFriction

◆ sPointId

◆ sPointInstanceId

◆ sPointKinematic

◆ sPointLength

◆ sPointMass

◆ sPointNormal

◆ sPointOrientation

◆ sPointPassthroughId

◆ sPointPosition

◆ sPointRatio

◆ sPointSignedAirLiquidDistance

◆ sPointSize

◆ sPointSourceId

◆ sPointSourceIndex

◆ sPointSourceOffsets

◆ sPointSourceWeight

◆ sPointSpin