Class ParticleEmitterFunction

Particle function graph asset that contains reusable part of the particle emitter graph.

Inheritance

Object

ScriptingObject

ManagedScriptingObject

Asset

BinaryAsset

ParticleEmitterFunction

Inherited Members

Asset::_deleteFileOnUnload

BinaryAsset::_dependantAssets

ScriptingObject::_gcHandle

BinaryAsset::_header

ScriptingObject::_id

BinaryAsset::_isSaving

Asset::_isVirtual

Asset::_loadingTask

Asset::_loadState

Asset::_refCount

BinaryAsset::_storageRef

ScriptingObject::_type

BinaryAsset::AddDependency(BinaryAsset* asset)

Asset::AddReference()

Asset::Asset(const SpawnParams& params, const AssetInfo* info)

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

Asset::CancelStreaming()

ScriptingObject::Cast(ScriptingObject* obj)

Asset::ChangeID(const Guid& newId)

BinaryAsset::ClearDependencies()

Asset::const

BinaryAsset::createLoadingTask()

Asset::CreateManaged()

ScriptingObject::CreateManagedInternal()

Asset::DECLARE_ENUM_7(LoadResult, Ok, Failed, MissingDataChunk, CannotLoadData, CannotLoadStorage, CannotLoadInitData, InvalidData)

ScriptingObject::Deleted

Asset::DeleteManaged()

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

BinaryAsset::Dependencies

Asset::DEPRECATED("Use GetReferences with assets and files parameter instead")

Asset::DestroyManaged()

ParticleEmitterFunction

Object::Flags

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

BinaryAsset::GetChunk(int32 index)

BinaryAsset::GetChunkData(int32 index, BytesContainer& data)

BinaryAsset::GetChunkSize(int32 index)

ScriptingObject::GetClass()

ScriptingObject::GetID()

BinaryAsset::GetImportMetadata(String& path, String& username)

BinaryAsset::GetImportPath()

ScriptingObject::GetManagedInstance()

BinaryAsset::GetMemoryUsage()

BinaryAsset::GetOrCreateChunk(int32 index)

ScriptingObject::GetOrCreateManagedInstance()

BinaryAsset::GetPath()

Asset::GetReferences(Array<Guid, HeapAllocation>& assets, Array<String, HeapAllocation>& files)

Asset::GetReferences()

Asset::GetReferencesCount()

BinaryAsset::GetSerializedVersion()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

Asset::GetTypeName()

BinaryAsset::HasChunk(int32 index)

BinaryAsset::HasChunkLoaded(int32 index)

BinaryAsset::HasDependenciesModified()

ScriptingObject::HasManagedInstance()

BinaryAsset::init(AssetInitData& initData)

BinaryAsset::Init(const FlaxStorageReference& storage, AssetHeader& header)

BinaryAsset::Init(AssetInitData& initData)

Asset::InitAsVirtual()

BinaryAsset::InitVirtual(AssetInitData& initData)

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

Asset::IsInternalType()

Asset::IsLoaded()

ScriptingObject::IsRegistered()

Asset::IsVirtual()

Asset::LastLoadFailed()

BinaryAsset::loadAsset()

BinaryAsset::LoadChunk(int32 chunkIndex)

BinaryAsset::LoadChunks(AssetChunksFlag chunks)

ParticleEmitterFunction

Asset::Locker

ManagedScriptingObject::ManagedScriptingObject(const SpawnParams& params)

BinaryAsset::Metadata

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

Asset::OnCheckSave(const StringView& path=StringView::Empty)

BinaryAsset::OnDeleteObject()

BinaryAsset::OnDependencyModified(BinaryAsset* asset)

Asset::onLoad(LoadAssetTask* task)

Asset::onLoaded()

Asset::OnLoaded

Asset::onLoaded_MainThread()

Asset::OnManagedInstanceDeleted()

Asset::OnReloading

BinaryAsset::onRename(const StringView& newPath)

Asset::OnScriptingDispose()

Asset::onUnload_MainThread()

Asset::OnUnloaded

ScriptingObject::RegisterObject()

BinaryAsset::Reimport()

BinaryAsset::ReleaseChunk(int32 index)

BinaryAsset::ReleaseChunks()

BinaryAsset::releaseStorage()

Asset::Reload()

Asset::RemoveReference()

BinaryAsset::RequestChunkDataAsync(int32 index)

BinaryAsset::SaveAsset(AssetInitData& data, bool silentMode=false)

BinaryAsset::SaveAsset(const StringView& path, AssetInitData& data, bool silentMode=false)

BinaryAsset::SaveToAsset(const StringView& path, AssetInitData& data, bool silentMode=false)

ScriptingObject::ScriptingObject(const SpawnParams& params)

BinaryAsset::SetChunk(int32 index, const Span<byte>& data)

ManagedScriptingObject::SetManagedInstance(MObject* instance)

Asset::ShouldDeleteFileOnUnload()

ParticleEmitterFunction

Asset::startLoading()

BinaryAsset::Storage

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

Asset::ToString()

ScriptingObject::UnregisterObject()

Asset::WaitForLoaded(double timeoutInMilliseconds=30000.0)

BinaryAsset::~BinaryAsset()

Object::~Object()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/Particles/ParticleEmitterFunction.h

Syntax

public class ParticleEmitterFunction : public BinaryAsset

Fields

Graph

The loaded CPU particle function graph.

Declaration

public ParticleEmitterGraphCPU Graph

Field Value

ParticleEmitterGraphCPU

GraphGPU

The loaded GPU particle function graph.

Declaration

public ParticleEmitterGraphGPU GraphGPU

Field Value

ParticleEmitterGraphGPU

Inputs

The input nodes (indices).

Declaration

public Array<int32, FixedAllocation<16>> Inputs

Field Value

Array<int32, FixedAllocation<16>>

Outputs

The output nodes (indices).

Declaration

public Array<int32, FixedAllocation<16>> Outputs

Field Value

Array<int32, FixedAllocation<16>>

Methods

getChunksToPreload()

Gets packed chunks indices to preload before asset loading action

Declaration

protected virtual AssetChunksFlag getChunksToPreload() const override

Returns

AssetChunksFlag Chunks to load flags

Overrides

BinaryAsset::getChunksToPreload()

GetSignature(Array<StringView, FixedAllocation<32>>& types, Array<StringView, FixedAllocation<32>>& names)

Declaration

public void GetSignature(Array<StringView, FixedAllocation<32>>& types, Array<StringView, FixedAllocation<32>>& names)

Parameters

Array<StringView, FixedAllocation<32>> types

Array<StringView, FixedAllocation<32>> names

load()

Load data from the chunks

Declaration

protected virtual LoadResult load() override

Returns

LoadResult Loading result

Overrides

BinaryAsset::load()

LoadSurface()

Tries to load surface graph from the asset.

Declaration

public BytesContainer LoadSurface()

Returns

BytesContainer The output surface data, or empty if failed to load.

LoadSurface(ParticleEmitterGraphCPU& graph, bool loadMeta=false)

Tries to load surface graph from the asset.

Declaration

public bool LoadSurface(ParticleEmitterGraphCPU& graph, bool loadMeta=false)

Parameters

ParticleEmitterGraphCPU graph The graph to load.

bool loadMeta True if load metadata.

Returns

bool True if failed, otherwise false.

LoadSurface(ParticleEmitterGraphGPU& graph)

Tries to load surface graph from the asset.

Declaration

public bool LoadSurface(ParticleEmitterGraphGPU& graph) const

Parameters

ParticleEmitterGraphGPU graph The graph to load.

Returns

bool True if failed, otherwise false.

Save(const StringView& path=StringView::Empty)

Saves this asset to the file. Supported only in Editor.

Declaration

public virtual bool Save(const StringView& path=StringView::Empty) override

Parameters

StringView path The custom asset path to use for the saving. Use empty value to save this asset to its own storage location. Can be used to duplicate asset. Must be specified when saving virtual asset.

Returns

bool True when cannot save data, otherwise false.

Overrides

Asset::Save(const StringView& path=StringView::Empty)

SaveSurface(const BytesContainer& data)

Updates the particle graph surface (save new one, discards cached data, reloads asset).

Declaration

public bool SaveSurface(const BytesContainer& data) const

Parameters

BytesContainer data The surface graph data.

Returns

bool True if cannot save it, otherwise false.

unload(bool isReloading)

Unloads asset data

Declaration

protected virtual void unload(bool isReloading) override

Parameters

bool isReloading True if asset is reloading data, otherwise false.

Overrides

Asset::unload(bool isReloading)