physx::apex::NxApexAsset Class Reference

Base class of all APEX assets. More...

#include <NxApexAsset.h>

Inheritance diagram for physx::apex::NxApexAsset:

List of all members.

Public Member Functions
virtual const char *	getName () const =0
	Returns the name of this deserialized asset.
virtual NxAuthObjTypeID	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 physx::PxU32	forceLoadAssets ()=0
	Returns the number of assets force loaded by all of this asset's named asset references.
virtual ::NxParameterized::Interface *	getDefaultActorDesc ()=0
	Returns the default actor descriptor NxParamaterized 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 ::NxParameterized::Interface *	getDefaultAssetPreviewDesc ()=0
	Returns the default AssetPreview descriptor NxParamaterized interface.
virtual const ::NxParameterized::Interface *	getAssetNxParameterized () const =0
	Returns the asset's NxParamaterized interface This cannot be directly modified! It is read only to the user.
virtual NxApexActor *	createApexActor (const ::NxParameterized::Interface &actorParams, NxApexScene &apexScene)=0
	Creates an Actor representing the Asset in a Scene.
virtual NxApexAssetPreview *	createApexAssetPreview (const ::NxParameterized::Interface &params, NxApexAssetPreviewScene *previewScene)=0
	Creates an Asset Preview for the asset.
virtual NxParameterized::Interface *	releaseAndReturnNxParameterizedInterface (void)=0
	Releases the ApexAsset but returns the NxParameterized::Interface and *ownership* to the caller.
virtual bool	isValidForActorCreation (const ::NxParameterized::Interface &actorParams, NxApexScene &) 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 NxAuthObjTypeID physx::apex::NxApexAsset::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 physx::apex::NxApexAsset::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 physx::apex::NxApexAsset::isValidForActorCreation	(	const ::NxParameterized::Interface &	actorParams,
		NxApexScene &
	)		const [pure virtual]

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

Parameters:

actorParams

parameters 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:

• NxApexAsset.h