APEX Framework: nvidia::apex::Actor Class Reference

NVIDIA APEX

nvidia::apex::Actor Class Reference

Base class for APEX module objects. More...

#include <Actor.h>

Inheritance diagram for nvidia::apex::Actor:
nvidia::apex::ApexInterface nvidia::apex::RWLockable nvidia::apex::AttractorFSActor nvidia::apex::BasicIosActor nvidia::apex::ClothingActor nvidia::apex::DestructibleActor nvidia::apex::EffectPackageActor nvidia::apex::EmitterActor nvidia::apex::FlameEmitterActor nvidia::apex::ForceFieldActor nvidia::apex::GroundEmitterActor nvidia::apex::HeatSourceActor nvidia::apex::ImpactEmitterActor nvidia::apex::IofxActor nvidia::apex::JetFSActor nvidia::apex::NoiseFSActor nvidia::apex::ParticleIosActor nvidia::apex::RenderMeshActor nvidia::apex::SubstanceSourceActor nvidia::apex::TurbulenceFSActor nvidia::apex::VelocitySourceActor nvidia::apex::VortexFSActor nvidia::apex::WindFSActor

List of all members.

Public Member Functions

virtual AssetgetOwner () const =0
 Returns the owning asset.
virtual void getLodRange (float &min, float &max, bool &intOnly) const =0
 Returns the range of possible values for physical Lod overwrite.
virtual float getActiveLod () const =0
 Get current physical lod.
virtual void forceLod (float lod)=0
 Force an APEX Actor to use a certian physical Lod.
virtual void cacheModuleData () const
 Ensure that all module-cached data is cached.
virtual void setEnableDebugVisualization (bool state)=0
 Selectively enables/disables debug visualization of a specific APEX actor. Default value it true.

Detailed Description

Base class for APEX module objects.


Member Function Documentation

virtual void nvidia::apex::Actor::forceLod ( float  lod) [pure virtual]

Force an APEX Actor to use a certian physical Lod.

Parameters:
[in]lodOverwrite the Lod system to use this Lod.
Note:
Setting the lod value to a negative number will turn off the overwrite and proceed with regular Lod computations
See also:
Actor::getLodRange()
virtual void nvidia::apex::Actor::getLodRange ( float &  min,
float &  max,
bool &  intOnly 
) const [pure virtual]

Returns the range of possible values for physical Lod overwrite.

Parameters:
[out]minThe minimum lod value
[out]maxThe maximum lod value
[out]intOnlyOnly integers are allowed if this is true, gets rounded to nearest
Note:
The max value can change with different graphical Lods
See also:
Actor::forceLod()

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.