PhysXObjectDesc.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 PHYS_XOBJECT_DESC_H
#define PHYS_XOBJECT_DESC_H

#include "ApexUsingNamespace.h"

namespace nvidia
{
namespace apex
{

class Actor;

PX_PUSH_PACK_DEFAULT

class PhysXObjectDesc
{
protected:
    uint32_t                mFlags;

    enum
    {
        TRANSFORM   = (1U << 31),   
        RAYCASTS    = (1U << 30), 
        CONTACTS    = (1U << 29) 
    };


public:
    virtual uint32_t                getApexActorCount() const = 0;
    virtual const Actor*    getApexActor(uint32_t i) const = 0;

    bool ignoreTransform() const
    {
        return (mFlags & (uint32_t)TRANSFORM) ? true : false;
    }
    bool ignoreRaycasts() const
    {
        return (mFlags & (uint32_t)RAYCASTS) ? true : false;
    }
    bool ignoreContacts() const
    {
        return (mFlags & (uint32_t)CONTACTS) ? true : false;
    }
    bool getUserDefinedFlag(uint32_t index) const
    {
        return (mFlags & (uint32_t)(1 << index)) ? true : false;
    }

    void*               userData;
};

// To get owning Actor's authorable object type name:
//      getActor()->getOwner()->getAuthObjName();
// To get owning Actor's authorable object type ID:
//      getActor()->getOwner()->getAuthObjType();

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // PHYS_XOBJECT_DESC_H