#include <ForceFieldActor.h>
Public Member Functions | |
virtual bool | isEnable ()=0 |
virtual bool | disable ()=0 |
virtual bool | enable ()=0 |
virtual PxMat44 | getPose () const =0 |
virtual void | setPose (const PxMat44 &pose)=0 |
virtual PX_DEPRECATED float | getScale () const =0 |
virtual PX_DEPRECATED void | setScale (float scale)=0 |
virtual PX_DEPRECATED float | getCurrentScale () const =0 |
virtual PX_DEPRECATED void | setCurrentScale (float scale)=0 |
virtual const char * | getName () const =0 |
virtual void | setName (const char *name)=0 |
virtual void | setStrength (const float strength)=0 |
virtual void | setLifetime (const float lifetime)=0 |
virtual PX_DEPRECATED void | setFalloffType (const char *type)=0 |
virtual PX_DEPRECATED void | setFalloffMultiplier (const float multiplier)=0 |
virtual ForceFieldAsset * | getForceFieldAsset () const =0 |
Detailed Description
ForceField Actor.
Member Function Documentation
virtual bool nvidia::apex::ForceFieldActor::disable | ( | ) | [pure virtual] |
Disable force field actor. Default status is enable. Can switch it freely. A disabled explosion actor still exists there, but has no effect to the scene.
virtual bool nvidia::apex::ForceFieldActor::enable | ( | ) | [pure virtual] |
Enable force field actor. Default status is enable. Can switch it freely. A disabled explosion actor still exists there, but has no effect to the scene.
virtual PX_DEPRECATED float nvidia::apex::ForceFieldActor::getCurrentScale | ( | ) | const [pure virtual] |
Gets the force field actor's scale.
virtual ForceFieldAsset* nvidia::apex::ForceFieldActor::getForceFieldAsset | ( | ) | const [pure virtual] |
Returns the asset the actor has been created from.
virtual const char* nvidia::apex::ForceFieldActor::getName | ( | ) | const [pure virtual] |
Retrieves the name string for the force field actor.
virtual PxMat44 nvidia::apex::ForceFieldActor::getPose | ( | ) | const [pure virtual] |
Gets location and orientation of the force field.
virtual PX_DEPRECATED float nvidia::apex::ForceFieldActor::getScale | ( | ) | const [pure virtual] |
Gets the force field actor's scale.
virtual bool nvidia::apex::ForceFieldActor::isEnable | ( | ) | [pure virtual] |
Return true if the force field actor is enabled.
virtual PX_DEPRECATED void nvidia::apex::ForceFieldActor::setCurrentScale | ( | float | scale | ) | [pure virtual] |
Sets the force field actor's scale. (0.0f, +inf)
virtual PX_DEPRECATED void nvidia::apex::ForceFieldActor::setFalloffMultiplier | ( | const float | multiplier | ) | [pure virtual] |
Set falloff multiplier for the force field actor. Only works for radial force field types.
virtual PX_DEPRECATED void nvidia::apex::ForceFieldActor::setFalloffType | ( | const char * | type | ) | [pure virtual] |
Set falloff type (linear, steep, scurve, custom, none) for the force field actor. Only works for radial force field types.
virtual void nvidia::apex::ForceFieldActor::setLifetime | ( | const float | lifetime | ) | [pure virtual] |
Set lifetime for the force field actor.
virtual void nvidia::apex::ForceFieldActor::setName | ( | const char * | name | ) | [pure virtual] |
Set a name string for the force field actor that can be retrieved with getName().
virtual void nvidia::apex::ForceFieldActor::setPose | ( | const PxMat44 & | pose | ) | [pure virtual] |
Sets location and orientation of the force field.
virtual PX_DEPRECATED void nvidia::apex::ForceFieldActor::setScale | ( | float | scale | ) | [pure virtual] |
Sets the force field actor's scale. (0.0f, +inf)
virtual void nvidia::apex::ForceFieldActor::setStrength | ( | const float | strength | ) | [pure virtual] |
Set strength for the force field actor.
The documentation for this class was generated from the following file:
Generated on Fri Dec 15 2017 13:58:39 Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.