Validator.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_VALIDATOR_H
#define BIFROST_GEOMETRY_VALIDATOR_H
 
#include <Bifrost/Geometry/GeometryExport.h>
 
#include <Bifrost/Object/Object.h>
 
namespace Bifrost {
namespace Geometry {
// -----------------------------------------------------------------------------
class BIFROST_GEOMETRY_DECL GeoValidator {
public:
    GeoValidator();
    virtual ~GeoValidator();
 
    enum class ErrorCode {
        kNoError = 0,
        kInvalidObject,
        kInvalidProperty,
        kInvalidSet,
        kInvalidCount,
        kInvalidIndex,
        kMissingTarget,
        kInvalidTarget
    };
 
    struct BIFROST_GEOMETRY_DECL Status {
        operator bool() const; // NOLINT
 
        Status();
        Status(GeoValidator::ErrorCode code, Amino::String desc);
 
        GeoValidator::ErrorCode m_code;
        Amino::String           m_desc;
    };
 
    virtual Status validate(const Bifrost::Object& object);
};
 
// -----------------------------------------------------------------------------
class BIFROST_GEOMETRY_DECL PointCloudValidator : public GeoValidator {
public:
    Status validate(const Bifrost::Object& object) override;
};
 
// -----------------------------------------------------------------------------
class BIFROST_GEOMETRY_DECL InstancesValidator : public GeoValidator {
public:
    Status validate(const Bifrost::Object& object) override;
};
 
// -----------------------------------------------------------------------------
class BIFROST_GEOMETRY_DECL StrandValidator : public GeoValidator {
public:
    Status validate(const Bifrost::Object& object) override;
};
 
// -----------------------------------------------------------------------------
class BIFROST_GEOMETRY_DECL MeshValidator : public GeoValidator {
public:
    Status validate(const Bifrost::Object& object) override;
};
 
// -----------------------------------------------------------------------------
class BIFROST_GEOMETRY_DECL VolumeValidator : public GeoValidator {
public:
    Status validate(const Bifrost::Object& object) override;
};
 
// -----------------------------------------------------------------------------
GeoValidator::Status BIFROST_GEOMETRY_DECL
validateMesh(const Bifrost::Object& in_object);
 
} // namespace Geometry
} // namespace Bifrost
 
#endif