Class Foliage

Represents a foliage actor that contains a set of instanced meshes.

Inheritance

Object

ScriptingObject

SceneObject

Actor

Foliage

Inherited Members

Actor::_box

Actor::_drawCategory

Actor::_drawNoCulling

ScriptingObject::_gcHandle

ScriptingObject::_id

Actor::_isActive

Actor::_isActiveInHierarchy

Actor::_isEnabled

Actor::_isHierarchyDirty

Actor::_isPrefabRoot

Actor::_layer

Actor::_localTransform

Actor::_name

SceneObject::_parent

Actor::_physicsScene

SceneObject::_prefabID

SceneObject::_prefabObjectID

Actor::_scene

Actor::_sphere

Actor::_staticFlags

Actor::_transform

ScriptingObject::_type

Actor::AddMovement(const Vector3& translation)

Actor::AddMovement(const Vector3& translation, const Quaternion& rotation)

Actor::AddScript()

Actor::AddStaticFlags(StaticFlags flags)

Actor::AddTag(const Tag& tag)

Actor::AddTagRecursive(const Tag& tag)

Foliage

Actor::BeginPlay(SceneBeginData* data)

Actor::BreakPrefabLink()

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

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

ScriptingObject::Cast(ScriptingObject* obj)

ScriptingObject::ChangeID(const Guid& newId)

Actor::ChangeScriptOrder(Script* script, int32 newIndex)

Actor::Children

Actor::Clone()

ScriptingObject::CreateManaged()

ScriptingObject::CreateManagedInternal()

ScriptingObject::Deleted

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

Object::DeleteObjectNow()

Actor::DEPRECATED("Use HasTag instead") const String& GetTag()

Actor::DEPRECATED("Use AddTag instead") void SetTag(const StringView& value)

ISerializable::DeserializeIfExists(DeserializeStream& stream, const char* memberName, ISerializeModifier* modifier)

Foliage

Actor::DestroyChildren(float timeLeft = 0.0f)

ScriptingObject::DestroyManaged()

Actor::EndPlay()

Actor::FindActor(const StringView& name)

Actor::FindActor(const MClass* type, bool activeOnly=false)

Actor::FindActor(const MClass* type, const StringView& name)

Actor::FindActor(const MClass* type, const Tag& tag, bool activeOnly=false)

Actor::FindActor()

Actor::FindActor(const Tag& tag)

Actor::FindScript(const MClass* type)

Actor::FindScript()

Object::Flags

Actor::FromBytes(const Span<byte>& data, Array<Actor* >& output, ISerializeModifier* modifier)

Actor::FromBytes(const Span<byte>& data)

Actor::FromBytes(const Span<byte>& data, const Dictionary<Guid, Guid, HeapAllocation>& idsMapping)

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

ScriptingObject::FromInterface(T* interfaceObj)

Actor::FromJson(const StringAnsiView& json)

Actor::GetBox()

Actor::GetBoxWithChildren()

Actor::GetChild(int32 index)

Actor::GetChild(const StringView& name)

Actor::GetChild(const MClass* type)

Actor::GetChild()

Actor::GetChildren(const MClass* type)

Actor::GetChildren()

Actor::GetChildrenCount()

ScriptingObject::GetClass()

Actor::GetDirection()

Actor::GetEditorBox()

Actor::GetEditorBoxChildren()

ScriptingObject::GetID()

Actor::GetIsActive()

Actor::GetLayer()

Actor::GetLayerMask()

Actor::GetLayerName()

Actor::GetLocalOrientation()

Actor::GetLocalPosition()

Actor::GetLocalScale()

Actor::GetLocalToWorldMatrix(Matrix& localToWorld)

Actor::GetLocalToWorldMatrix(Double4x4& localToWorld)

Actor::GetLocalTransform()

ScriptingObject::GetManagedInstance()

Actor::GetName()

SceneObject::GetNamePath(Char separatorChar='/')

Actor::GetOrAddChild()

ScriptingObject::GetOrCreateManagedInstance()

Actor::GetOrderInParent()

Actor::GetOrientation()

SceneObject::GetParent()

Actor::GetPerInstanceRandom()

Actor::GetPhysicsScene()

Actor::GetPosition()

SceneObject::GetPrefabID()

SceneObject::GetPrefabObjectID()

Actor::GetPrefabRoot()

Actor::GetRotation()

Actor::GetScale()

Actor::GetScene()

Actor::GetSceneObjectId()

Actor::GetSceneRendering()

Actor::GetScript(int32 index)

Actor::GetScript(const MClass* type)

Actor::GetScript()

Actor::GetScriptByID(const Guid& id)

Actor::GetScripts(const MClass* type)

Actor::GetScripts()

Actor::GetScriptsCount()

Actor::GetSphere()

Actor::GetStaticFlags()

Actor::GetTransform()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

Actor::GetWorldToLocalMatrix(Matrix& worldToLocal)

Actor::GetWorldToLocalMatrix(Double4x4& worldToLocal)

Actor::HasActorInChildren(Actor* a)

Actor::HasActorInHierarchy(Actor* a)

Actor::HasContentLoaded()

ScriptingObject::HasManagedInstance()

SceneObject::HasParent()

SceneObject::HasPrefabLink()

Actor::HasScene()

Actor::HasStaticFlag(StaticFlags flag)

Actor::HasTag()

Actor::HasTag(const Tag& tag)

Actor::HasTag(const StringView& tag)

Actor::HideFlags

Actor::Initialize()

Actor::InitializeHierarchy()

Actor::Intersects(const Ray& ray, Real& distance, Vector3& normal)

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

Actor::IsActiveInHierarchy()

SceneObject::IsDuringPlay()

Actor::IsPrefabRoot()

ScriptingObject::IsRegistered()

Actor::IsStatic()

Actor::IsTransformStatic()

Actor::LinkPrefab(const Guid& prefabId, const Guid& prefabObjectId)

Actor::LookAt(const Vector3& worldPos)

Actor::LookAt(const Vector3& worldPos, const Vector3& worldUp)

Actor::LookingAt(const Vector3& worldPos)

Actor::LookingAt(const Vector3& worldPos, const Vector3& worldUp)

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

Actor::OnActiveChanged()

Actor::OnActiveInTreeChanged()

Actor::OnBeginPlay()

Actor::OnDebugDraw()

Actor::OnDebugDrawSelected()

Actor::OnDeleteObject()

Actor::OnEndPlay()

ScriptingObject::OnManagedInstanceDeleted()

Actor::OnOrderInParentChanged()

Actor::OnParentChanged()

Actor::OnPhysicsSceneChanged(PhysicsScene* previous)

ScriptingObject::OnScriptingDispose()

Actor::OnStaticFlagsChanged()

ScriptingObject::RegisterObject()

Actor::RemoveStaticFlags(StaticFlags flags)

Actor::RemoveTag(const Tag& tag)

Actor::ResetLocalTransform()

SceneObject::SceneObject(const SpawnParams& params)

ScriptingObject::ScriptingObject(const SpawnParams& params)

Actor::Scripts

Foliage

Foliage

Actor::SetDirection(const Float3& value)

Actor::SetIsActive(bool value)

Actor::SetLayer(int32 layerIndex)

Actor::SetLayerName(const StringView& value)

Actor::SetLayerNameRecursive(const StringView& value)

Actor::SetLayerRecursive(int32 layerIndex)

Actor::SetLocalOrientation(const Quaternion& value)

Actor::SetLocalPosition(const Vector3& value)

Actor::SetLocalScale(const Float3& value)

Actor::SetLocalTransform(const Transform& value)

ScriptingObject::SetManagedInstance(MObject* instance)

Actor::SetName(String&& value)

Actor::SetName(const StringView& value)

Actor::SetOrderInParent(int32 index)

Actor::SetOrientation(const Quaternion& value)

Actor::SetParent(Actor* value, bool worldPositionsStays, bool canBreakPrefabLink)

Actor::SetParent(Actor* value, bool canBreakPrefabLink=true)

SceneObject::SetParent(Actor* value)

Actor::SetPhysicsScene(PhysicsScene* scene)

Actor::SetPosition(const Vector3& value)

Actor::SetRotation(const Matrix& value)

Actor::SetScale(const Float3& value)

Actor::SetStaticFlag(StaticFlags flag, bool value)

Actor::SetStaticFlags(StaticFlags value)

Actor::SetTransform(const Transform& value)

Foliage

Actor::Tags

Actor::ToBytes(const Array<Actor* >& actors, MemoryWriteStream& output)

Actor::ToBytes(const Array<Actor* >& actors)

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

ScriptingObject::ToInterface(ScriptingObject* obj)

Actor::ToJson()

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

Actor::ToString()

Actor::TreeExecute(Function<bool(Actor* , Params ...)>& action, Params ... args)

Actor::TreeExecuteChildren(Function<bool(Actor* , Params ...)>& action, Params ... args)

Actor::TryGetSerializedObjectsIds(const Span<byte>& data)

ScriptingObject::UnregisterObject()

Actor::UnregisterObjectHierarchy()

ISerializable::~ISerializable()

Object::~Object()

SceneObject::~SceneObject()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/Foliage/Foliage.h

Syntax

public class Foliage : public Actor

Fields

FoliageTypes

The foliage instances types used by the current foliage actor. It's read-only.

Declaration

public Array<FoliageType> FoliageTypes

Field Value

Array<FoliageType>

Instances

The allocated foliage instances. It's read-only.

Declaration

public ChunkedArray<FoliageInstance, FOLIAGE_INSTANCE_CHUNKS_SIZE> Instances

Field Value

ChunkedArray<FoliageInstance, FOLIAGE_INSTANCE_CHUNKS_SIZE>

Methods

AddFoliageType(Model* model)

Adds the type of the foliage.

Declaration

public void AddFoliageType(Model* model)

Parameters

Model model The model to assign. It cannot be null nor already used by the other instance type (it must be unique within the given foliage actor).

AddInstance(const FoliageInstance& instance)

Adds the new foliage instance. Ensure to always call RebuildClusters() after editing foliage to sync cached data (call it once after editing one or more instances).

Input instance bounds, instance random and world matrix are ignored (recalculated).

Declaration

public void AddInstance(const FoliageInstance& instance)

Parameters

FoliageInstance instance The instance.

Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

Deserializes object from the input stream.

Declaration

public virtual void Deserialize(DeserializeStream& stream, ISerializeModifier* modifier) override

Parameters

DeserializeStream stream The input stream.

ISerializeModifier modifier The deserialization modifier object. Always valid.

Overrides

ISerializable::Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

Draw(RenderContext& renderContext)

Draws this actor. Called by Scene Rendering service. This call is more optimized than generic Draw (eg. geometry is rendered during all pass types but other actors are drawn only during GBufferFill pass).

Declaration

public virtual void Draw(RenderContext& renderContext) override

Parameters

RenderContext renderContext The rendering context.

Overrides

Actor::Draw(RenderContext& renderContext)

Draw(RenderContextBatch& renderContextBatch)

Draws this actor. Called by Scene Rendering service. This call is more optimized than generic Draw (eg. geometry is rendered during all pass types but other actors are drawn only during GBufferFill pass).

Declaration

public virtual void Draw(RenderContextBatch& renderContextBatch) override

Parameters

RenderContextBatch renderContextBatch The rendering context batch (eg, main view and shadow projections).

Overrides

Actor::Draw(RenderContextBatch& renderContextBatch)

GetFoliageType(int32 index)

Gets the foliage type.

Declaration

public FoliageType* GetFoliageType(int32 index)

Parameters

int32 index The zero-based index of the foliage type.

Returns

FoliageType The foliage type.

GetFoliageTypeInstancesCount(int32 index)

Gets the total amount of the instanced that use the given foliage type.

Declaration

public int32 GetFoliageTypeInstancesCount(int32 index) const

Parameters

int32 index The zero-based index of the foliage type.

Returns

int32 The foliage type instances count.

GetFoliageTypesCount()

Gets the total amount of the types of foliage.

Declaration

public int32 GetFoliageTypesCount() const

Returns

int32 The foliage types count.

GetGlobalDensityScale()

Gets the global density scale for all foliage instances. The default value is 1. Use values from range 0-1. Lower values decrease amount of foliage instances in-game. Use it to tweak game performance for slower devices.

Declaration

public static float GetGlobalDensityScale()

Returns

float

GetInstance(int32 index)

Gets the foliage instance by index.

Declaration

public FoliageInstance GetInstance(int32 index) const

Parameters

int32 index The zero-based index of the foliage instance.

Returns

FoliageInstance The foliage instance data.

GetInstancesCount()

Gets the total amount of the instanced of foliage.

Declaration

public int32 GetInstancesCount() const

Returns

int32 The foliage instances count.

Intersects(const Ray& ray, Real& distance, Vector3& normal, int32& instanceIndex)

Determines if there is an intersection between the current object or any it's child and a ray.

Declaration

public bool Intersects(const Ray& ray, Real& distance, Vector3& normal, int32& instanceIndex)

Parameters

Ray ray The ray to test.

Real distance When the method completes, contains the distance of the intersection (if any valid).

Vector3 normal When the method completes, contains the intersection surface normal vector (if any valid).

int32 instanceIndex When the method completes, contains zero-based index of the foliage instance that is the closest to the ray.

Returns

bool True whether the two objects intersected, otherwise false.

IntersectsItself(const Ray& ray, Real& distance, Vector3& normal)

Determines if there is an intersection between the current object and a ray.

Declaration

public virtual bool IntersectsItself(const Ray& ray, Real& distance, Vector3& normal) override

Parameters

Ray ray The ray to test.

Real distance When the method completes, contains the distance of the intersection (if any valid).

Vector3 normal When the method completes, contains the intersection surface normal vector (if any valid).

Returns

bool True whether the two objects intersected, otherwise false.

Overrides

Actor::IntersectsItself(const Ray& ray, Real& distance, Vector3& normal)

OnDisable()

Called when actor gets removed from game systems. Occurs on EndPlay event or when actor gets inactivated in hierarchy. Use this event to unregister object from other game system (eg. audio).

Declaration

protected virtual void OnDisable() override

Overrides

Actor::OnDisable()

OnEnable()

Called when actor gets added to game systems. Occurs on BeginPlay event or when actor gets activated in hierarchy. Use this event to register object to other game system (eg. audio).

Declaration

protected virtual void OnEnable() override

Overrides

Actor::OnEnable()

OnFoliageTypeModelLoaded(int32 index)

Called when foliage type model is loaded.

Declaration

public void OnFoliageTypeModelLoaded(int32 index)

Parameters

int32 index The zero-based index of the foliage type.

OnLayerChanged()

Called when layer gets changed.

Declaration

public virtual void OnLayerChanged() override

Overrides

Actor::OnLayerChanged()

OnTransformChanged()

Called when actor transform gets changed.

Declaration

protected virtual void OnTransformChanged() override

Overrides

Actor::OnTransformChanged()

RebuildClusters()

Rebuilds the foliage clusters used as internal acceleration structures (quad tree).

Declaration

public void RebuildClusters()

RemoveAllInstances()

Clears all foliage instances. Preserves the foliage types and other properties.

Declaration

public void RemoveAllInstances()

RemoveFoliageType(int32 index)

Removes the foliage instance type and all foliage instances using this type.

Declaration

public void RemoveFoliageType(int32 index)

Parameters

int32 index The zero-based index of the foliage instance type.

RemoveInstance(ChunkedArray<FoliageInstance, FOLIAGE_INSTANCE_CHUNKS_SIZE>::Iterator i)

Removes the foliage instance. Ensure to always call RebuildClusters() after editing foliage to sync cached data (call it once after editing one or more instances).

Declaration

public void RemoveInstance(ChunkedArray<FoliageInstance, FOLIAGE_INSTANCE_CHUNKS_SIZE>::Iterator i)

Parameters

ChunkedArray<FoliageInstance, FOLIAGE_INSTANCE_CHUNKS_SIZE>::Iterator i The iterator from foliage instances that points to the instance to remove.

RemoveInstance(int32 index)

Removes the foliage instance. Ensure to always call RebuildClusters() after editing foliage to sync cached data (call it once after editing one or more instances).

Declaration

public void RemoveInstance(int32 index)

Parameters

int32 index The zero-based index of the instance to remove.

Serialize(SerializeStream& stream, const void* otherObj)

Serializes object to the output stream compared to the values of the other object instance (eg. default class object). If other object is null then serialize all properties.

Declaration

public virtual void Serialize(SerializeStream& stream, const void* otherObj) override

Parameters

SerializeStream stream The output stream.

void otherObj The instance of the object to compare with and serialize only the modified properties. If null, then serialize all properties.

Overrides

ISerializable::Serialize(SerializeStream& stream, const void* otherObj)

SetGlobalDensityScale(float value)

Sets the global density scale for all foliage instances. The default value is 1. Use values from range 0-1. Lower values decrease amount of foliage instances in-game. Use it to tweak game performance for slower devices.

Declaration

public static void SetGlobalDensityScale(float value)

Parameters

float value

SetInstanceTransform(int32 index, const Transform& value)

Sets the foliage instance transformation. Ensure to always call RebuildClusters() after editing foliage to sync cached data (call it once after editing one or more instances).

Declaration

public void SetInstanceTransform(int32 index, const Transform& value)

Parameters

int32 index The zero-based index of the foliage instance.

Transform value The value.

UpdateCullDistance()

Updates the cull distance for all foliage instances and for created clusters.

Declaration

public void UpdateCullDistance()

See Also

Actor