I3DHVersion.h Source File

I3DHVersion.h Source File#

instant3Dhub: I3DHVersion.h Source File
instant3Dhub
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "Kismet/BlueprintFunctionLibrary.h"
 
#include "I3DHVersion.generated.h"
namespace I3DHVersion
{
    INSTANT3DHUB_API int32 GetPluginVersionMajor();
    INSTANT3DHUB_API int32 GetPluginVersionMinor();
    INSTANT3DHUB_API int32 GetPluginVersionPatch();
    INSTANT3DHUB_API FString GetPluginVersionString();
 
} // namespace I3DHVersion
UCLASS()
class INSTANT3DHUB_API UI3DHVersion : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    UFUNCTION(BlueprintPure, Category = "{instant3Dhub}|Version")
    static int32 GetPluginVersionMajor();
    UFUNCTION(BlueprintPure, Category = "{instant3Dhub}|Version")
    static int32 GetPluginVersionMinor();
    UFUNCTION(BlueprintPure, Category = "{instant3Dhub}|Version")
    static int32 GetPluginVersionPatch();
    UFUNCTION(BlueprintPure, Category = "{instant3Dhub}|Version")
    static FString GetPluginVersionString();
};
 
// ----------------------------------------------------------
// Version Comparison Macros
// ----------------------------------------------------------
// NOTE: Sourced from EngineVersionComparison.h
 
// Helper for INSTANT3DHUB_VERSION_NEWER_THAN and INSTANT3DHUB_VERSION_OLDER_THAN
#define INSTANT3DHUB_GREATER_SORT(Value, ValueToBeGreaterThan, TieBreaker) \
    (((Value) > (ValueToBeGreaterThan)) || (((Value) == (ValueToBeGreaterThan)) && (TieBreaker)))
 
// Helper for INSTANT3DHUB_VERSION_EQUALS
#define INSTANT3DHUB_EQUAL_SORT(Value, ValueToBeEqualTo, TieBreaker) \
    (((Value) == (ValueToBeEqualTo)) && (TieBreaker))
#define INSTANT3DHUB_VERSION_NEWER_THAN(MajorVersion, MinorVersion, PatchVersion) \
    INSTANT3DHUB_GREATER_SORT(INSTANT3DHUB_VERSION_MAJOR, MajorVersion, INSTANT3DHUB_GREATER_SORT(INSTANT3DHUB_VERSION_MINOR, MinorVersion, INSTANT3DHUB_GREATER_SORT(INSTANT3DHUB_VERSION_PATCH, PatchVersion, false)))
#define INSTANT3DHUB_VERSION_OLDER_THAN(MajorVersion, MinorVersion, PatchVersion) \
    INSTANT3DHUB_GREATER_SORT(MajorVersion, INSTANT3DHUB_VERSION_MAJOR, INSTANT3DHUB_GREATER_SORT(MinorVersion, INSTANT3DHUB_VERSION_MINOR, INSTANT3DHUB_GREATER_SORT(PatchVersion, INSTANT3DHUB_VERSION_PATCH, false)))
#define INSTANT3DHUB_VERSION_EQUALS(MajorVersion, MinorVersion, PatchVersion) \
    INSTANT3DHUB_EQUAL_SORT(MajorVersion, INSTANT3DHUB_VERSION_MAJOR, INSTANT3DHUB_EQUAL_SORT(MinorVersion, INSTANT3DHUB_VERSION_MINOR, INSTANT3DHUB_EQUAL_SORT(PatchVersion, INSTANT3DHUB_VERSION_PATCH, true)))
#define INSTANT3DHUB_FEATURE_METADATA 1
#define INSTANT3DHUB_FEATURE_DEBUG_METRICS 1
#define INSTANT3DHUB_FEATURE_SUBMESH 1
#define INSTANT3DHUB_FEATURE_SPACE_API 1
 
// ----------------------------------------------------------
// Deprecation
// ----------------------------------------------------------
// NOTE: For more info on how to use see description of UE_DEPRECATED Macro in CoreMiscDefines.h
#if defined(__INTELLISENSE__)
#define INSTANT3DHUB_DEPRECATED(Version, Message)
#else
#define INSTANT3DHUB_DEPRECATED(Version, Message) [[deprecated(Message " - Please update your code to the new instant3Dhub API before upgrading to the next release, otherwise your project will no longer compile.")]]
#endif
 
// ----------------------------------------------------------
// Experimental
// ----------------------------------------------------------
 
#ifndef I3DH_VALIDATE_EXPERIMENTAL_API
#define I3DH_VALIDATE_EXPERIMENTAL_API 1
#endif
 
// NOTE: For more info on how to use see description of UE_DEPRECATED Macro in CoreMiscDefines.h
#if defined(__INTELLISENSE__) || !I3DH_VALIDATE_EXPERIMENTAL_API
#define INSTANT3DHUB_EXPERIMENTAL(Version, Message)
#else
#define INSTANT3DHUB_EXPERIMENTAL(Version, Message) [[deprecated(Message " - This API is experimental. As such, there is no guarantee that it won't change or be removed in future releases. Please use at your own risk.")]]
#endif
 
// Suppresses the warning emitted by @ref INSTANT3DHUB_EXPERIMENTAL when plugin code uses one of its own
// experimental APIs. Gated on the same I3DH_VALIDATE_EXPERIMENTAL_API switch as the marker so suppression
// is active exactly when the warning is emitted.
//
// This is intentionally distinct from the engine's PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS: the engine macro
// is gated on UE_VALIDATE_EXPERIMENTAL_API (off by default) and from UE 5.6 on it overrides our fallback
// below, so it does not suppress this plugin's [[deprecated]]-based experimental warning. Use these macros
// for instant3Dhub-experimental symbols, and the engine macro for engine-experimental symbols.
#if I3DH_VALIDATE_EXPERIMENTAL_API
#define I3DH_PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS PRAGMA_DISABLE_DEPRECATION_WARNINGS
#define I3DH_PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS PRAGMA_ENABLE_DEPRECATION_WARNINGS
#else
#define I3DH_PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
#define I3DH_PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
#endif
 
// NOTE: These macros are also defined by Unreal Engine starting with version 5.6. We provide these
// definitions as fallback for backwards compatibility, therefore they do not have an INSTANT3DHUB /
// I3DH prefix.
#ifndef PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
#define PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS PRAGMA_DISABLE_DEPRECATION_WARNINGS
#endif
 
#ifndef PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
#define PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS PRAGMA_ENABLE_DEPRECATION_WARNINGS
#endif