Asset.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2017, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */


#ifndef ASSET_H
#define ASSET_H

#include "ApexInterface.h"
#include "ApexSDK.h"
#include "AssetPreviewScene.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

typedef const char* PlatformTag;

class Actor;
class AssetPreview;

class Asset : public ApexInterface
{
public:
    virtual const char* getName() const = 0;

    virtual AuthObjTypeID getObjTypeID() const = 0;

    virtual const char* getObjTypeName() const = 0;

    virtual uint32_t forceLoadAssets() = 0;

    virtual ::NvParameterized::Interface* getDefaultActorDesc() = 0;

    virtual ::NvParameterized::Interface* getDefaultAssetPreviewDesc() = 0;

    virtual const ::NvParameterized::Interface* getAssetNvParameterized() const = 0;

    virtual Actor* createApexActor(const ::NvParameterized::Interface& actorParams, Scene& apexScene) = 0;

    virtual AssetPreview* createApexAssetPreview(const ::NvParameterized::Interface& params, AssetPreviewScene* previewScene) = 0;

    virtual NvParameterized::Interface* releaseAndReturnNvParameterizedInterface(void) = 0;

    virtual bool isValidForActorCreation(const ::NvParameterized::Interface& actorParams, Scene& /*apexScene*/) const = 0;

    virtual bool isDirty() const = 0;

protected:
    virtual ~Asset() {}; // illegal, do not call
};

class AssetAuthoring : public ApexInterface
{
public:
    virtual const char* getName() const = 0;

    virtual const char* getObjTypeName() const = 0;

    virtual bool prepareForPlatform(nvidia::apex::PlatformTag) = 0;

    virtual ::NvParameterized::Interface* getNvParameterized() const = 0;

    virtual NvParameterized::Interface* releaseAndReturnNvParameterizedInterface(void) = 0;

    virtual void setToolString(const char* toolName, const char* toolVersion, uint32_t toolChangelist) = 0;
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // ASSET_H