Actor.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 ACTOR_H
#define ACTOR_H

#include "ApexInterface.h"

#if PX_PHYSICS_VERSION_MAJOR == 3
#include "PxActor.h"
#include "PxShape.h"
#include "PxFiltering.h"
namespace nvidia { namespace apex
{

#define APEX_DEFAULT_WAKE_UP_COUNTER 0.4f

#define APEX_ACTOR_TEMPLATE_PARAM(_type, _name, _valid, _default) \
bool is##_name##Valid(_type x) const { PX_UNUSED(x); return _valid; } \
_type getDefault##_name() const { return _default; } \
virtual _type get##_name() const = 0; \
virtual bool set##_name(_type) = 0

class PhysX3DescTemplate
{
public:
    /*
        For each Name below, there are functions: getName(), setName(), isNameValid(), and getDefaultName().  For example:

        PxDominanceGroup    getDominanceGroup() const;
        bool                setDominanceGroup(PxDominanceGroup);    // Returns true iff the passed-in value is valid.  (Note, will set the internal values even if they are not valid.)
        bool                isDominanceGroupValid() const;
        PxDominanceGroup    getDefaultDominanceGroup() const;
    */

    /*                           Type                       Name                    Validity Condition      Default Value */
    // Actor
    APEX_ACTOR_TEMPLATE_PARAM(physx::PxDominanceGroup,  DominanceGroup,     (1),                    0);
    APEX_ACTOR_TEMPLATE_PARAM(uint8_t,              ActorFlags,             (1),                    physx::PxActorFlag::eSEND_SLEEP_NOTIFIES);
    APEX_ACTOR_TEMPLATE_PARAM(physx::PxClientID,    OwnerClient,            (1),                    0);
    APEX_ACTOR_TEMPLATE_PARAM(uint32_t,             ClientBehaviorBits,     (1),                    0);
    APEX_ACTOR_TEMPLATE_PARAM(uint16_t,             ContactReportFlags,     (1),                    0);
    APEX_ACTOR_TEMPLATE_PARAM(void*,                UserData,               (1),                    NULL);
    APEX_ACTOR_TEMPLATE_PARAM(const char*,          Name,                   (1),                    NULL);

    // Body
    APEX_ACTOR_TEMPLATE_PARAM(float,                Density,                (x >= 0.0f),            1.0f);
    APEX_ACTOR_TEMPLATE_PARAM(uint8_t,              BodyFlags,              (1),                    0);
    APEX_ACTOR_TEMPLATE_PARAM(float,                WakeUpCounter,          (x >= 0.0f),            APEX_DEFAULT_WAKE_UP_COUNTER);
    APEX_ACTOR_TEMPLATE_PARAM(float,                LinearDamping,          (x >= 0.0f),            0.0f);
    APEX_ACTOR_TEMPLATE_PARAM(float,                AngularDamping,         (x >= 0.0f),            0.05f);
    APEX_ACTOR_TEMPLATE_PARAM(float,                MaxAngularVelocity,     (1),                    7.0f);
    APEX_ACTOR_TEMPLATE_PARAM(float,                SleepLinearVelocity,    (1),                    0.0f);
    APEX_ACTOR_TEMPLATE_PARAM(uint32_t,             SolverIterationCount,   (x >= 1 && x <= 255),   4);
    APEX_ACTOR_TEMPLATE_PARAM(uint32_t,             VelocityIterationCount, (x >= 1 && x <= 255),   1);
    APEX_ACTOR_TEMPLATE_PARAM(float,                ContactReportThreshold, (1),                    PX_MAX_F32);
    APEX_ACTOR_TEMPLATE_PARAM(float,                SleepThreshold,         (1),                    0.005f);

    // Shape
    APEX_ACTOR_TEMPLATE_PARAM(uint8_t,              ShapeFlags,             (1),                    physx::PxShapeFlag::eSIMULATION_SHAPE | physx::PxShapeFlag::eSCENE_QUERY_SHAPE | physx::PxShapeFlag::eVISUALIZATION);
    APEX_ACTOR_TEMPLATE_PARAM(void*,                ShapeUserData,          (1),                    NULL);
    APEX_ACTOR_TEMPLATE_PARAM(const char*,          ShapeName,              (1),                    NULL);
    APEX_ACTOR_TEMPLATE_PARAM(physx::PxFilterData,  SimulationFilterData,   (1),                    physx::PxFilterData(0, 0, 0, 0));
    APEX_ACTOR_TEMPLATE_PARAM(physx::PxFilterData,  QueryFilterData,        (1),                    physx::PxFilterData(0, 0, 0, 0));
    APEX_ACTOR_TEMPLATE_PARAM(float,                ContactOffset,          (1),                    -1.0f);
    APEX_ACTOR_TEMPLATE_PARAM(float,                RestOffset,             (1),                    PX_MAX_F32);
    // Shape materials get explicitly defined API:
    virtual physx::PxMaterial** getMaterials(uint32_t& materialCount) const = 0;
    virtual bool                setMaterials(physx::PxMaterial** materialArray, uint32_t materialCount) = 0;    // Must have non-zero sized array of materials to be valid.


    virtual void release() = 0;

protected:
    virtual ~PhysX3DescTemplate() {}
};  // PhysX3DescTemplate

#undef APEX_ACTOR_TEMPLATE_PARAM

}}
#endif

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class Asset;

class Actor : public ApexInterface
{
public:
    virtual Asset* getOwner() const = 0;

    virtual void getLodRange(float& min, float& max, bool& intOnly) const = 0;

    virtual float getActiveLod() const = 0;

    virtual void forceLod(float lod) = 0;

    virtual void cacheModuleData() const {}

    virtual void setEnableDebugVisualization(bool state) = 0;
    

protected:
    virtual ~Actor() {} // use release() method instead!
};

#if PX_PHYSICS_VERSION_MAJOR == 3

class ActorSource
{
public:
    virtual void setPhysX3Template(const PhysX3DescTemplate*) = 0;

    virtual bool getPhysX3Template(PhysX3DescTemplate& dest) const = 0;

    virtual PhysX3DescTemplate* createPhysX3DescTemplate() const = 0;
};

#endif

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // ACTOR_H