Bifrost SDK
Bifrost SDK documentation
Volume functions

Functions

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL Bifrost::Geometry::getVolumePrototype ()
 Returns the prototypical volume object. More...
 
void BIFROST_GEOMETRY_DECL Bifrost::Geometry::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 Bifrost::Geometry::getLevelSetPrototype ()
 Returns the prototypical level set object. More...
 
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL Bifrost::Geometry::getFogVolumePrototype ()
 Returns the prototypical fog volume object. More...
 
Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL Bifrost::Geometry::getFlipLiquidPrototype ()
 Returns the prototypical liquid set object. More...
 
void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateFlipLiquid (Bifrost::Object &object)
 Populate an object with the required properties to conform to the liquid geometry schema. More...
 
void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateLevelSet (Bifrost::Object &object)
 Populate an object with the required properties to conform to the level set geometry schema. More...
 
void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateFogVolume (Bifrost::Object &object)
 Populate an object with the required properties to conform to the fog volume geometry schema. More...
 

Detailed Description

Functions for creating empty volumes.

Function Documentation

◆ getFlipLiquidPrototype()

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

Returns the prototypical liquid set object.

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

Returns
The liquid prototype

◆ getFogVolumePrototype()

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

Returns the prototypical fog volume object.

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

Returns
The fogVolume prototype

◆ getLevelSetPrototype()

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

Returns the prototypical level set object.

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

Returns
The levelSet prototype

◆ getVolumePrototype()

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

Returns the prototypical volume object.

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

Returns
The volume prototype

◆ populateFlipLiquid()

void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateFlipLiquid ( Bifrost::Object object)

Populate an object with the required properties to conform to the liquid geometry schema.

The liquid is initially empty.

Parameters
[in,out]objectLiquid geometry object to be populated.

◆ populateFogVolume()

void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateFogVolume ( Bifrost::Object object)

Populate an object with the required properties to conform to the fog volume geometry schema.

The fog volume is initially empty.

Parameters
[in,out]objectlevel set geometry object to be populated.

◆ populateLevelSet()

void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateLevelSet ( Bifrost::Object object)

Populate an object with the required properties to conform to the level set geometry schema.

The level set is initially empty.

Parameters
[in,out]objectlevel set geometry object to be populated.

◆ populateVolume()

void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateVolume ( Bifrost::Object object)

Populate an object with the required properties to conform to the volume geometry schema.

The volume is initially empty.

Parameters
[in,out]objectVolume geometry object to be populated.