find_attribute_utils.h

/*
 * Copyright 2022 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
#pragma once
 
#include <lagrange/SurfaceMesh.h>
#include <lagrange/utils/BitField.h>
#include <lagrange/utils/span.h>
 
#include <string>
#include <string_view>
 
namespace lagrange::internal {

enum class ResetToDefault { Yes, No };

enum class ShouldBeWritable { Yes, No };

struct CheckAttributeResult
{
    bool success = true; 
    std::string msg; 
};

template <typename ExpectedValueType, typename Scalar, typename Index>
CheckAttributeResult check_attribute(
    const SurfaceMesh<Scalar, Index>& mesh,
    AttributeId id,
    BitField<AttributeElement> expected_element,
    AttributeUsage expected_usage,
    size_t expected_channels,
    ShouldBeWritable expected_writable = ShouldBeWritable::No);

template <typename ExpectedValueType, typename Scalar, typename Index>
AttributeId find_matching_attribute(
    const SurfaceMesh<Scalar, Index>& mesh,
    std::string_view name,
    BitField<AttributeElement> expected_element,
    AttributeUsage expected_usage,
    size_t expected_channels);

template <typename ExpectedValueType, typename Scalar, typename Index>
AttributeId find_matching_attribute(
    const SurfaceMesh<Scalar, Index>& mesh,
    span<const AttributeId> selected_ids,
    BitField<AttributeElement> expected_element,
    AttributeUsage expected_usage,
    size_t expected_channels);

template <typename ExpectedValueType, typename Scalar, typename Index>
AttributeId find_attribute(
    const SurfaceMesh<Scalar, Index>& mesh,
    std::string_view name,
    BitField<AttributeElement> expected_element,
    AttributeUsage expected_usage,
    size_t expected_channels);

template <typename ExpectedValueType, typename Scalar, typename Index>
AttributeId find_or_create_attribute(
    SurfaceMesh<Scalar, Index>& mesh,
    std::string_view name,
    AttributeElement expected_element,
    AttributeUsage expected_usage,
    size_t expected_channels,
    ResetToDefault reset_tag);
 
} // namespace lagrange::internal