RenderMeshActor.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 RENDER_MESH_ACTOR_H
#define RENDER_MESH_ACTOR_H

#include "Actor.h"
#include "Renderable.h"
#include "UserRenderResourceManager.h"  // For RenderCullMode
#include "foundation/PxVec3.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class UserRenderInstanceBuffer;

struct RenderMeshActorRaycastFlags
{
    enum Enum
    {
        VISIBLE_PARTS = (1 << 0),
        INVISIBLE_PARTS =   (1 << 1),

        ALL_PARTS =         VISIBLE_PARTS | INVISIBLE_PARTS
    };
};

struct RenderMeshActorRaycastHitData
{
    float       time;

    uint32_t    partIndex;

    uint32_t    submeshIndex;

    uint32_t    vertexIndices[3];

    PxVec3      normal;

    PxVec3      tangent;

    PxVec3      binormal;
};


class RenderMeshActor : public Actor, public Renderable
{
public:

    enum
    {
        InvalidInstanceID = 0xFFFFFFFF
    };

    virtual bool                    getVisibilities(uint8_t* visibilityArray, uint32_t visibilityArraySize) const = 0;

    virtual bool                    setVisibility(bool visible, uint16_t partIndex = 0) = 0;

    virtual bool                    isVisible(uint16_t partIndex = 0) const = 0;

    virtual uint32_t                visiblePartCount() const = 0;

    virtual const uint32_t*         getVisibleParts() const = 0;

    virtual uint32_t                getBoneCount() const = 0;

    virtual void                    setTM(const PxMat44& tm, uint32_t boneIndex = 0) = 0;

    virtual void                    setTM(const PxMat44& tm, const PxVec3& scale, uint32_t boneIndex = 0) = 0;

    virtual void                    updateBounds() = 0;

    virtual const PxMat44           getTM(uint32_t boneIndex = 0) const = 0;

    virtual void                    setReleaseResourcesIfNothingToRender(bool value) = 0;

    virtual void                    setBufferVisibility(bool bufferVisibility) = 0;

    virtual void                    setOverrideMaterial(uint32_t submeshIndex, const char* overrideMaterialName) = 0;

    virtual void                    syncVisibility(bool useLock = true) = 0;

    virtual UserRenderInstanceBuffer* getInstanceBuffer() const = 0;
    virtual void                    setInstanceBuffer(UserRenderInstanceBuffer* instBuf) = 0;
    virtual void                    setMaxInstanceCount(uint32_t count) = 0;
    virtual void                    setInstanceBufferRange(uint32_t from, uint32_t count) = 0;

    virtual bool                    rayCast(RenderMeshActorRaycastHitData& hitData,
                                            const PxVec3& worldOrig, const PxVec3& worldDisp,
                                            RenderMeshActorRaycastFlags::Enum flags = RenderMeshActorRaycastFlags::VISIBLE_PARTS,
                                            RenderCullMode::Enum winding = RenderCullMode::CLOCKWISE,
                                            int32_t partIndex = -1) const = 0;

protected:

    virtual                         ~RenderMeshActor() {}
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // RENDER_MESH_ACTOR_H