include/PxVisualizationParameter.h

File members: include/PxVisualizationParameter.h

// 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) 2008-2024 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.

#ifndef PX_VISUALIZATION_PARAMETER_H
#define PX_VISUALIZATION_PARAMETER_H

#include "foundation/PxPreprocessor.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

/*
NOTE: Parameters should NOT be conditionally compiled out. Even if a particular feature is not available.
Otherwise the parameter values get shifted about and the numeric values change per platform. This causes problems
when trying to serialize parameters.

New parameters should also be added to the end of the list for this reason. Also make sure to update
eNUM_VALUES, which should be one higher than the maximum value in the enum.
*/

struct PxVisualizationParameter
{
    enum Enum
    {
    /* RigidBody-related parameters  */

        eSCALE,

        eWORLD_AXES,

    /* Body visualizations */

        eBODY_AXES,

        eBODY_MASS_AXES,

        eBODY_LIN_VELOCITY,

        eBODY_ANG_VELOCITY,

    /* Contact visualisations */

        eCONTACT_POINT,

        eCONTACT_NORMAL,

        eCONTACT_ERROR,

        eCONTACT_IMPULSE,

        eCONTACT_FORCE PX_DEPRECATED = eCONTACT_IMPULSE,

        eFRICTION_POINT,

        eFRICTION_NORMAL,

        eFRICTION_IMPULSE,

        eACTOR_AXES,

        eCOLLISION_AABBS,

        eCOLLISION_SHAPES,

        eCOLLISION_AXES,

        eCOLLISION_COMPOUNDS,

        eCOLLISION_FNORMALS,

        eCOLLISION_EDGES,

        eCOLLISION_STATIC,

        eCOLLISION_DYNAMIC,

        eJOINT_LOCAL_FRAMES,

        eJOINT_LIMITS,

        eCULL_BOX,

        eMBP_REGIONS,

        eSIMULATION_MESH,

        eSDF,

        eNUM_VALUES,

        eFORCE_DWORD = 0x7fffffff
    };
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif