PxConvexMeshDesc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, 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.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_COLLISION_NXCONVEXMESHDESC
#define PX_COLLISION_NXCONVEXMESHDESC

#include "foundation/PxVec3.h"
#include "foundation/PxFlags.h"
#include "common/PxCoreUtilityTypes.h"
#include "geometry/PxConvexMesh.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

struct PxConvexFlag
{
    enum Enum
    {
        PX_DEPRECATED eFLIPNORMALS      =   (1<<0),

        e16_BIT_INDICES     =   (1<<1),

        eCOMPUTE_CONVEX     =   (1<<2), 

        eINFLATE_CONVEX     =   (1<<3),

        eCHECK_ZERO_AREA_TRIANGLES      =   (1<<4)
    };
};

typedef PxFlags<PxConvexFlag::Enum,PxU16> PxConvexFlags;
PX_FLAGS_OPERATORS(PxConvexFlag::Enum,PxU16)


typedef PxVec3 PxPoint;

class PxConvexMeshDesc
{
public:

    PxBoundedData points;

    PX_DEPRECATED PxBoundedData triangles;

    PxBoundedData polygons;

    PxBoundedData indices;

    PxConvexFlags flags;

    PxU16 vertexLimit;

    PX_INLINE PxConvexMeshDesc();
    PX_INLINE void setToDefault();
    PX_INLINE bool isValid() const;
};

PX_INLINE PxConvexMeshDesc::PxConvexMeshDesc()  //constructor sets to default
    : vertexLimit(256)
{
}

PX_INLINE void PxConvexMeshDesc::setToDefault()
{
    *this = PxConvexMeshDesc();
}

PX_INLINE bool PxConvexMeshDesc::isValid() const
{
    // Check geometry
    if(points.count < 3 ||  //at least 1 trig's worth of points
        (points.count > 0xffff && flags & PxConvexFlag::e16_BIT_INDICES))
        return false;
    if(!points.data)
        return false;
    if(points.stride < sizeof(PxPoint)) //should be at least one point's worth of data
        return false;

    // Check topology
    // The triangles pointer is not mandatory: the vertex cloud is enough to define the convex hull.
    if(triangles.data)
    {
        // Indexed mesh
        if(triangles.count < 2) //some algos require at least 2 trigs
            return false;

        PxU32 limit = (flags & PxConvexFlag::e16_BIT_INDICES) ? sizeof(PxU16)*3 : sizeof(PxU32)*3;
        if(triangles.stride < limit) 
            return false;
    }
    else
    {
        if(polygons.data)
        {
            if(polygons.count < 4) // we require 2 neighbours for each vertex - 4 polygons at least
                return false;

            if(!indices.data) // indices must be provided together with polygons
                return false;

            PxU32 limit = (flags & PxConvexFlag::e16_BIT_INDICES) ? sizeof(PxU16) : sizeof(PxU32);
            if(indices.stride < limit) 
                return false;

            limit = sizeof(PxHullPolygon);
            if(polygons.stride < limit) 
                return false;
        }
        else
        {
            // We can compute the hull from the vertices
            if(!(flags & PxConvexFlag::eCOMPUTE_CONVEX))
                return false;   // If the mesh is convex and we're not allowed to compute the hull,
                                // you have to provide it completely (geometry & topology).
        }
    }

    if(vertexLimit < 4 || vertexLimit > 256)
    {
        return false;
    }
    return true;
}

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif