APEX Framework: nvidia::apex::Asset Class Reference

NVIDIA APEX

nvidia::apex::Asset Class Reference

Base class of all APEX assets. More...

#include <Asset.h>

Inheritance diagram for nvidia::apex::Asset:
nvidia::apex::ApexInterface nvidia::apex::RWLockable nvidia::apex::BasicFSAsset nvidia::apex::ClothingAsset nvidia::apex::DestructibleAsset nvidia::apex::EffectPackageAsset nvidia::apex::EmitterAsset nvidia::apex::FlameEmitterAsset nvidia::apex::ForceFieldAsset nvidia::apex::GroundEmitterAsset nvidia::apex::HeatSourceAsset nvidia::apex::ImpactEmitterAsset nvidia::apex::IofxAsset nvidia::apex::IosAsset nvidia::apex::RenderMeshAsset nvidia::apex::SubstanceSourceAsset nvidia::apex::TurbulenceFSAsset nvidia::apex::VelocitySourceAsset

List of all members.

Public Member Functions

virtual const char * getName () const =0
 Returns the name of this deserialized asset.
virtual AuthObjTypeID getObjTypeID () const =0
 Returns the ID of the asset's authorable object type.
virtual const char * getObjTypeName () const =0
 Returns the name of this asset's authorable object type.
virtual uint32_t forceLoadAssets ()=0
 Returns the number of assets force loaded by all of this asset's named asset references.
virtual
::NvParameterized::Interface
getDefaultActorDesc ()=0
 Returns the default actor descriptor NvParamaterized interface Memory ownership stays with this asset. The user may modify the interface values, but they will not persist past another acll to 'getDefaultActorDesc' Typically used to create an actor after making small local editing changes.
virtual
::NvParameterized::Interface
getDefaultAssetPreviewDesc ()=0
 Returns the default AssetPreview descriptor NvParamaterized interface.
virtual const
::NvParameterized::Interface
getAssetNvParameterized () const =0
 Returns the asset's NvParamaterized interface This cannot be directly modified! It is read only to the user.
virtual ActorcreateApexActor (const ::NvParameterized::Interface &actorParams, Scene &apexScene)=0
 Creates an Actor representing the Asset in a Scene.
virtual AssetPreviewcreateApexAssetPreview (const ::NvParameterized::Interface &params, AssetPreviewScene *previewScene)=0
 Creates an Asset Preview for the asset.
virtual
NvParameterized::Interface
releaseAndReturnNvParameterizedInterface (void)=0
 Releases the ApexAsset but returns the NvParameterized::Interface and *ownership* to the caller.
virtual bool isValidForActorCreation (const ::NvParameterized::Interface &actorParams, Scene &) const =0
 Returns true if the asset is in a state that is valid for creating an actor.
virtual bool isDirty () const =0
 Returns true if the parameterized object of the asset has been modified.

Detailed Description

Base class of all APEX assets.


Member Function Documentation

virtual AuthObjTypeID nvidia::apex::Asset::getObjTypeID ( ) const [pure virtual]

Returns the ID of the asset's authorable object type.

Every asset will correspond to an APEX authorable object type. The module must register those types with the SDK at startup.

virtual bool nvidia::apex::Asset::isDirty ( ) const [pure virtual]

Returns true if the parameterized object of the asset has been modified.

This flag will be reset once the parameterized object has been serialized again.

virtual bool nvidia::apex::Asset::isValidForActorCreation ( const ::NvParameterized::Interface actorParams,
Scene  
) const [pure virtual]

Returns true if the asset is in a state that is valid for creating an actor.

Parameters:
actorParamsparameters of actor to create
Returns:
true if call to createApexActor will return true on inputs, false otherwise

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

Generated on Fri Dec 15 2017 13:58:37

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