NxRenderMeshActor.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and 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.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2014 NVIDIA Corporation. All rights reserved.

#ifndef NX_RENDER_MESH_ACTOR_H
#define NX_RENDER_MESH_ACTOR_H

#include "NxApexActor.h"
#include "NxApexRenderable.h"
#include "NxUserRenderResourceManager.h"    // For NxRenderCullMode
#include "foundation/PxVec3.h"

namespace physx
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class NxUserRenderInstanceBuffer;

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

        ALL_PARTS =         VISIBLE_PARTS | INVISIBLE_PARTS
    };
};

struct NxRenderMeshActorRaycastHitData
{
    physx::PxF32    time;

    physx::PxU32    partIndex;

    physx::PxU32    submeshIndex;

    physx::PxU32    vertexIndices[3];

    physx::PxVec3   normal;

    physx::PxVec3   tangent;

    physx::PxVec3   binormal;
};


class NxRenderMeshActor : public NxApexActor, public NxApexRenderable
{
public:

    enum
    {
        InvalidInstanceID = 0xFFFFFFFF
    };

    virtual bool                    getVisibilities(physx::PxU8* visibilityArray, physx::PxU32 visibilityArraySize) const = 0;

    virtual bool                    setVisibility(bool visible, physx::PxU16 partIndex = 0) = 0;

    virtual bool                    isVisible(physx::PxU16 partIndex = 0) const = 0;

    virtual physx::PxU32            visiblePartCount() const = 0;

    virtual const physx::PxU32*     getVisibleParts() const = 0;

    virtual physx::PxU32            getBoneCount() const = 0;

    virtual void                    setTM(const physx::PxMat44& tm, physx::PxU32 boneIndex = 0) = 0;

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

    virtual void                    updateBounds() = 0;

    virtual const physx::PxMat44    getTM(physx::PxU32 boneIndex = 0) const = 0;

    virtual void                    setReleaseResourcesIfNothingToRender(bool value) = 0;

    virtual void                    setBufferVisibility(bool bufferVisibility) = 0;

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

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

    virtual NxUserRenderInstanceBuffer* getInstanceBuffer() const = 0;
    virtual void                    setInstanceBuffer(NxUserRenderInstanceBuffer* instBuf) = 0;
    virtual void                    setMaxInstanceCount(physx::PxU32 count) = 0;
    virtual void                    setInstanceBufferRange(physx::PxU32 from, physx::PxU32 count) = 0;

    virtual bool                    rayCast(NxRenderMeshActorRaycastHitData& hitData,
                                            const physx::PxVec3& worldOrig, const physx::PxVec3& worldDisp,
                                            NxRenderMeshActorRaycastFlags::Enum flags = NxRenderMeshActorRaycastFlags::VISIBLE_PARTS,
                                            NxRenderCullMode::Enum winding = NxRenderCullMode::CLOCKWISE,
                                            physx::PxI32 partIndex = -1) const = 0;

protected:

    virtual                         ~NxRenderMeshActor() {}
};

PX_POP_PACK

}
} // end namespace physx::apex

#endif // NX_RENDER_MESH_ACTOR_H