Bifrost SDK
Bifrost SDK documentation
Strand functions

Functions

Amino::Ptr< Bifrost::Object > BIFROST_GEOMETRY_DECL Bifrost::Geometry::getStrandPrototype ()
 Returns the prototypical strand object. More...
 
void BIFROST_GEOMETRY_DECL Bifrost::Geometry::populateStrand (Bifrost::Object &object)
 Populate an object with the required properties to conform to the strand geometry schema. More...
 
bool BIFROST_GEOMETRY_DECL Bifrost::Geometry::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...
 

Detailed Description

Functions for creating Strand geometry objects.

Function Documentation

◆ getStrandPrototype()

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

Returns the prototypical strand object.

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

Returns
The strand prototype

◆ populateStrand() [1/2]

bool BIFROST_GEOMETRY_DECL Bifrost::Geometry::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.

The strand is initialized with the specified data.

Parameters
[in]positionsThe initial positions.
[in]strandOffsetsThe initial offsets.
[in,out]objectStrand geometry object to be populated.

◆ populateStrand() [2/2]

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

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

The strand is initially empty.

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