APEX IOFX Module: nvidia::apex::IofxAsset Class Reference

NVIDIA APEX

nvidia::apex::IofxAsset Class Reference

IOFX Asset public interface. Used to define the way the visual parameters are created from physical parameters of a particle. More...

#include <IofxAsset.h>

List of all members.

Public Member Functions

virtual const char * getSpriteMaterialName () const =0
 get the name of the material used for sprite-based particles visualization
virtual uint32_t getMeshAssetCount () const =0
 get the number of different mesh assets used for mesh-based particles visualization
virtual const char * getMeshAssetName (uint32_t index=0) const =0
virtual uint32_t getMeshAssetWeight (uint32_t index=0) const =0
virtual const ModifiergetSpawnModifiers (uint32_t &outCount) const =0
 get the list of spawn modifiers
virtual const ModifiergetContinuousModifiers (uint32_t &outCount) const =0
 get the list of continuous modifiers
virtual float getScaleUpperBound (float maxVelocity) const =0
virtual void addDependentActor (ApexActor *actor)=0

Detailed Description

IOFX Asset public interface. Used to define the way the visual parameters are created from physical parameters of a particle.


Member Function Documentation

virtual void nvidia::apex::IofxAsset::addDependentActor ( ApexActor *  actor) [pure virtual]

the IOFX asset needs to inform other actors when it is released

Note:
only for internal use
virtual const Modifier* nvidia::apex::IofxAsset::getContinuousModifiers ( uint32_t &  outCount) const [pure virtual]

get the list of continuous modifiers

virtual uint32_t nvidia::apex::IofxAsset::getMeshAssetCount ( ) const [pure virtual]

get the number of different mesh assets used for mesh-based particles visualization

virtual const char* nvidia::apex::IofxAsset::getMeshAssetName ( uint32_t  index = 0) const [pure virtual]

get the name of one of the mesh assets used for mesh-based particles visualization

Parameters:
indexmesh asset internal index
virtual uint32_t nvidia::apex::IofxAsset::getMeshAssetWeight ( uint32_t  index = 0) const [pure virtual]

get the weight of one of the mesh assets used for mesh-based particles visualization. Can be any value; not normalized.

Parameters:
indexmesh asset internal index
virtual float nvidia::apex::IofxAsset::getScaleUpperBound ( float  maxVelocity) const [pure virtual]

get the biggest possible scale given the current spawn- and continuous modifiers note that some modifiers depend on velocity, so the scale can get arbitrarily large.

Parameters:
maxVelocitythis value defines what the highest expected velocity is to compute the upper bound
virtual const Modifier* nvidia::apex::IofxAsset::getSpawnModifiers ( uint32_t &  outCount) const [pure virtual]

get the list of spawn modifiers

virtual const char* nvidia::apex::IofxAsset::getSpriteMaterialName ( ) const [pure virtual]

get the name of the material used for sprite-based particles visualization


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

Generated on Fri Dec 15 2017 13:59:03

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.