APEX Framework: nvidia::apex::PhysX3DescTemplate Class Reference

NVIDIA APEX

nvidia::apex::PhysX3DescTemplate Class Reference

#include <Actor.h>

List of all members.

Public Member Functions

 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)
 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)
 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)
virtual physx::PxMaterial ** getMaterials (uint32_t &materialCount) const =0
virtual bool setMaterials (physx::PxMaterial **materialArray, uint32_t materialCount)=0
virtual void release ()=0

Detailed Description

Template for PhysX3.x actor, body and shape. Used by the Destruction module when creating PhysX objects.

See ApexActorSource::setPhysX3Template and ActorSource::getPhysX3Template.


Member Function Documentation

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( physx::PxDominanceGroup  ,
DominanceGroup  ,
(1)  ,
 
)

getX(), setX(), getDefaultX(), and isXValid() for X=DominanceGroup (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( uint8_t  ,
ActorFlags  ,
(1)  ,
physx::PxActorFlag::eSEND_SLEEP_NOTIFIES   
)

getX(), setX(), getDefaultX(), and isXValid() for X=ActorFlags (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( uint32_t  ,
ClientBehaviorBits  ,
(1)  ,
 
)

getX(), setX(), getDefaultX(), and isXValid() for X=ClientBehaviorBits (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
Density  ,
(x >=0.0f)  ,
1.  0f 
)

getX(), setX(), getDefaultX(), and isXValid() for X=Density (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
RestOffset  ,
(1)  ,
PX_MAX_F32   
)

getX(), setX(), getDefaultX(), and isXValid() for X=RestOffset (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
ContactOffset  ,
(1)  ,
-1.  0f 
)

getX(), setX(), getDefaultX(), and isXValid() for X=ContactOffset (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( physx::PxFilterData  ,
QueryFilterData  ,
(1)  ,
physx::  PxFilterData0, 0, 0, 0 
)

getX(), setX(), getDefaultX(), and isXValid() for X=QueryFilterData (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( physx::PxFilterData  ,
SimulationFilterData  ,
(1)  ,
physx::  PxFilterData0, 0, 0, 0 
)

getX(), setX(), getDefaultX(), and isXValid() for X=SimulationFilterData (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( const char *  ,
ShapeName  ,
(1)  ,
NULL   
)

getX(), setX(), getDefaultX(), and isXValid() for X=ShapeName (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( void *  ,
ShapeUserData  ,
(1)  ,
NULL   
)

getX(), setX(), getDefaultX(), and isXValid() for X=ShapeUserData (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( uint8_t  ,
ShapeFlags  ,
(1)  ,
physx::PxShapeFlag::eSIMULATION_SHAPE|physx::PxShapeFlag::eSCENE_QUERY_SHAPE|physx::PxShapeFlag::eVISUALIZATION   
)

getX(), setX(), getDefaultX(), and isXValid() for X=ShapeFlags (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
SleepThreshold  ,
(1)  ,
0.  005f 
)

getX(), setX(), getDefaultX(), and isXValid() for X=SleepThreshold (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( uint32_t  ,
VelocityIterationCount  ,
(x >=1 &&x<=255)  ,
 
)

getX(), setX(), getDefaultX(), and isXValid() for X=VelocityIterationCount (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
ContactReportThreshold  ,
(1)  ,
PX_MAX_F32   
)

getX(), setX(), getDefaultX(), and isXValid() for X=ContactReportThreshold (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( uint32_t  ,
SolverIterationCount  ,
(x >=1 &&x<=255)  ,
 
)

getX(), setX(), getDefaultX(), and isXValid() for X=SolverIterationCount (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
SleepLinearVelocity  ,
(1)  ,
0.  0f 
)

getX(), setX(), getDefaultX(), and isXValid() for X=SleepLinearVelocity (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
MaxAngularVelocity  ,
(1)  ,
7.  0f 
)

getX(), setX(), getDefaultX(), and isXValid() for X=MaxAngularVelocity (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
AngularDamping  ,
(x >=0.0f)  ,
0.  05f 
)

getX(), setX(), getDefaultX(), and isXValid() for X=AngularDamping (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
LinearDamping  ,
(x >=0.0f)  ,
0.  0f 
)

getX(), setX(), getDefaultX(), and isXValid() for X=LinearDamping (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( float  ,
WakeUpCounter  ,
(x >=0.0f)  ,
APEX_DEFAULT_WAKE_UP_COUNTER   
)

getX(), setX(), getDefaultX(), and isXValid() for X=WakeUpCounter (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( uint8_t  ,
BodyFlags  ,
(1)  ,
 
)

getX(), setX(), getDefaultX(), and isXValid() for X=BodyFlags (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( uint16_t  ,
ContactReportFlags  ,
(1)  ,
 
)

getX(), setX(), getDefaultX(), and isXValid() for X=ContactReportFlags (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( const char *  ,
Name  ,
(1)  ,
NULL   
)

getX(), setX(), getDefaultX(), and isXValid() for X=Name (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( void *  ,
UserData  ,
(1)  ,
NULL   
)

getX(), setX(), getDefaultX(), and isXValid() for X=UserData (see APEX_ACTOR_TEMPLATE_PARAM)

nvidia::apex::PhysX3DescTemplate::APEX_ACTOR_TEMPLATE_PARAM ( physx::PxClientID  ,
OwnerClient  ,
(1)  ,
 
)

getX(), setX(), getDefaultX(), and isXValid() for X=OwnerClient (see APEX_ACTOR_TEMPLATE_PARAM)

virtual physx::PxMaterial** nvidia::apex::PhysX3DescTemplate::getMaterials ( uint32_t &  materialCount) const [pure virtual]

getMaterials function is non-generic, as it returns two parameters (the materials array and the array size in materialCount)

virtual void nvidia::apex::PhysX3DescTemplate::release ( ) [pure virtual]

Use this method to release this object

virtual bool nvidia::apex::PhysX3DescTemplate::setMaterials ( physx::PxMaterial **  materialArray,
uint32_t  materialCount 
) [pure virtual]

setMaterials function is non-generic, as it sets two parameters (the materials array in materialArray and the array size in materialCount)


The documentation for this class was generated from the following file:

Generated on Fri Dec 15 2017 13:58:36
Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.