GeoProperty.h

Go to the documentation of this file.

//-
//*****************************************************************************
// Copyright (c) 2025 Autodesk, Inc.
// All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// =============================================================================
//+
//
 
#ifndef BIFROST_GEOMETRY_GEO_PROPERTY_H
#define BIFROST_GEOMETRY_GEO_PROPERTY_H
 
#include <Bifrost/Geometry/GeometryExport.h>
 
#include <Bifrost/Geometry/GeoPropertyKey.h>
#include <Bifrost/Geometry/GeometryTypes.h>
#include <Bifrost/Math/Types.h>
#include <Bifrost/Object/Object.h>
 
#include <Amino/Core/StringView.h>
 
namespace Bifrost {
namespace Geometry {
 
// -----------------------------------------------------------------------------
// GeoProperty methods
//
 
 
 
Amino::Ptr<Bifrost::Object> BIFROST_GEOMETRY_DECL getGeoPropTarget(const Bifrost::Object& object,
                                                                   const Bifrost::Object& geoProp);
 
Amino::String BIFROST_GEOMETRY_DECL getGeoPropTargetName(const Bifrost::Object& object,
                                                         Amino::StringView      geoProp);
 
Amino::String BIFROST_GEOMETRY_DECL getGeoPropTargetName(const Bifrost::Object& geoProp);
 
Amino::String BIFROST_GEOMETRY_DECL getTargetComponent(const Bifrost::Object& object,
                                                       Amino::StringView      geoProp);
 
Amino::Array<Amino::String> BIFROST_GEOMETRY_DECL getTargetChain(const Bifrost::Object& object,
                                                                 Amino::StringView      geoProp);
 
// ---------------------------------------------------------------------------------------
// ComponentGeoProperty methods
 
 
Amino::Ptr<Bifrost::Object> BIFROST_GEOMETRY_DECL getComponentGeoPropPrototype();
 
void BIFROST_GEOMETRY_DECL populateComponentGeoProperty(Amino::uint_t    elementCount,
                                                        Bifrost::Object& object);
 
bool BIFROST_GEOMETRY_DECL setElementCount(Amino::StringView component,
                                           Amino::uint_t     elementCount,
                                           Bifrost::Object&  object);
 
Amino::uint_t BIFROST_GEOMETRY_DECL getElementCount(const Bifrost::Object& object,
                                                    Amino::StringView      component);
 
Amino::uint_t BIFROST_GEOMETRY_DECL getElementCount(const Bifrost::Object& compGeoProp);
 
// -----------------------------------------------------------------------------
// DataGeoProperty methods
 
 
Amino::Ptr<Bifrost::Object> BIFROST_GEOMETRY_DECL
getDataGeoPropPrototype(Amino::StringView property = Geometry::sGenericDataGeoProp);
 
template <typename T>
void populateDataGeoProperty(T defaultValue, Bifrost::Object& object) {
    Amino::Ptr<Amino::Array<T>> data = Amino::newClassPtr<Amino::Array<T>>();
    object.setProperty(Geometry::sData, data);
 
    object.setProperty(Geometry::sTarget, Geometry::sNullString);
 
    Amino::Ptr<Amino::Array<Amino::String>> depends =
        Amino::newClassPtr<Amino::Array<Amino::String>>(0);
    object.setProperty(Geometry::sDependsOn, depends);
 
    object.setProperty(Geometry::sDefault, defaultValue);
 
    object.setProperty(Geometry::sInterp, Bifrost::Geometry::Common::DataInterpolationMode::Linear);
}
 
template <typename DataType>
void populateDataGeoProperty(const DataType&                    defaultValue,
                             Amino::Ptr<Amino::Array<DataType>> data,
                             Amino::StringView                  target,
                             Bifrost::Object&                   geoProp) {
    populateDataGeoProperty(defaultValue, geoProp);
 
    geoProp.setProperty(Geometry::sTarget, target);
    geoProp.setProperty(Geometry::sData, data);
}
 
Amino::Ptr<Bifrost::Object> BIFROST_GEOMETRY_DECL getDataGeoProperty(const Bifrost::Object& object,
                                                                     Amino::StringView property);
 
template <typename T>
Amino::Ptr<Amino::Array<T>> getDataGeoPropValues(const Bifrost::Object& object,
                                                 Amino::StringView      property) {
    Amino::Any propVal = object.getProperty(property);
    auto       dataObj = Amino::any_cast<Amino::Ptr<Bifrost::Object>>(&propVal);
    if (!dataObj || dataObj->get() == nullptr || !(*dataObj)->hasProperty(Geometry::sData)) {
        return nullptr;
    }
 
    auto dataVal = (*dataObj)->getProperty(Geometry::sData);
    auto data    = Amino::any_cast<Amino::Ptr<Amino::Array<T>>>(&dataVal);
    return data ? std::move(*data) : nullptr;
}
 
template <typename DataType>
bool setDataGeoPropValues(Amino::StringView                  property,
                          Amino::Ptr<Amino::Array<DataType>> dataPropValues,
                          Bifrost::Object&                   object) {
    Amino::Any val     = object.getProperty(property);
    auto       dataObj = Amino::any_cast<Amino::Ptr<Bifrost::Object>>(&val);
    if (!dataObj || dataObj->get() == nullptr || !(*dataObj)->hasProperty(Geometry::sData)) {
        return false;
    }
 
    auto dataObj2 = dataObj->toMutable();
    dataObj2->setProperty(Geometry::sData, dataPropValues);
    object.setProperty(property, std::move(dataObj2));
 
    return true;
}
 
bool BIFROST_GEOMETRY_DECL isOffsetDataGeoProp(const Bifrost::Object& object,
                                               Amino::StringView      property);
 
// -----------------------------------------------------------------------------
// RangeGeoProperty methods
 
 
Amino::Ptr<Bifrost::Object> BIFROST_GEOMETRY_DECL getRangeGeoPropPrototype();
 
void BIFROST_GEOMETRY_DECL populateRangeGeoProperty(Bifrost::Object& object);
 
bool BIFROST_GEOMETRY_DECL populateRangeGeoProperty(Amino::Ptr<Amino::Array<Index>> indices,
                                                    Amino::StringView               target,
                                                    Bifrost::Object&                geoProp);
 
Amino::Ptr<Bifrost::Object> BIFROST_GEOMETRY_DECL getRangeGeoProperty(const Bifrost::Object& object,
                                                                      Amino::StringView property);
 
Amino::Ptr<Amino::Array<Index>> BIFROST_GEOMETRY_DECL
getRangeGeoPropIndices(const Bifrost::Object& object, Amino::StringView property);
 
Amino::Ptr<Amino::Array<Index>> BIFROST_GEOMETRY_DECL
getRangeGeoPropIndices(const Bifrost::Object& rangeGeoProp);
 
bool BIFROST_GEOMETRY_DECL setRangeGeoPropIndices(Amino::StringView               property,
                                                  Amino::Ptr<Amino::Array<Index>> indices,
                                                  Bifrost::Object&                object);
 
void BIFROST_GEOMETRY_DECL populateTrivialRangeIndices(size_t count, Amino::Array<Index>& indices);
 
Amino::String BIFROST_GEOMETRY_DECL getGeoPropRangeName(Amino::StringView geoProp);
 
// -----------------------------------------------------------------------------
// General Geometry Property functions
 
 
Amino::Array<Amino::Ptr<Bifrost::Object>> BIFROST_GEOMETRY_DECL
getGeoPropsByPrototype(Bifrost::Object const& object, Bifrost::Object const& prototype);
 
Amino::Array<Amino::Ptr<Bifrost::Object>> BIFROST_GEOMETRY_DECL
getGeoPropsByTarget(Bifrost::Object const& object, Amino::StringView target);
 
Amino::Array<Amino::String> BIFROST_GEOMETRY_DECL
getGeoPropNamesByPrototype(Bifrost::Object const& object, Bifrost::Object const& prototype);
 
Amino::Array<Amino::String> BIFROST_GEOMETRY_DECL
getGeoPropNamesByTarget(Bifrost::Object const& object, Amino::StringView target);
 
Amino::Array<Amino::String> BIFROST_GEOMETRY_DECL getGeoPropsByName(Bifrost::Object const& object,
                                                                    Amino::StringView      pattern);
 
Amino::String BIFROST_GEOMETRY_DECL getUniqueGeoPropName(Amino::StringView      propertyName,
                                                         Bifrost::Object const& object);
 
 
} // namespace Geometry
} // namespace Bifrost
 
#endif // BIFROST_GEO_PROPERTY_H