Asset.h

Go to the documentation of this file.

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.



#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