Class SceneCSGData

CSG geometry data container (used per scene).

ISerializable
SceneCSGData
Namespace: CSG
Assembly: FlaxEngine.dll
File: Engine/Level/Scene/SceneCSGData.h
Syntax
public class SceneCSGData : public ISerializable

Constructors

SceneCSGData(Scene* scene)

Initializes a new instance of the SceneCSGData class.

Declaration
public SceneCSGData(Scene* scene)
Parameters
Scene scene

The parent scene.

Fields

BuildTime

CSG mesh building action time (registered by CSG::Builder, in UTC format). Invalid if not build by active engine instance.

Declaration
public DateTime BuildTime
Field Value
DateTime

CollisionData

The CSG mesh collision data.

Declaration
public AssetReference<CollisionData> CollisionData
Field Value
AssetReference<CollisionData>

Data

The CSG mesh raw data.

Declaration
public AssetReference<RawDataAsset> Data
Field Value
AssetReference<RawDataAsset>

DataBrushLocations

The brush data locations lookup for faster searching though Data container.

Declaration
public Dictionary<Guid, int32> DataBrushLocations
Field Value
Dictionary<Guid, int32>

Model

The model mesh (used for rendering).

Declaration
public AssetReference<Model> Model
Field Value
AssetReference<Model>

PostCSGBuild

The post CSG build action. Called by the CSGBuilder after CSG mesh building end.

Declaration
public Action PostCSGBuild
Field Value
Action

Methods

BuildCSG(float timeoutMs=50)

Build CSG geometry for the given scene.

Declaration
public void BuildCSG(float timeoutMs=50) const
Parameters
float timeoutMs

The timeout to wait before building CSG (in milliseconds).

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

HasData()

Determines whether this container has CSG data linked.

Declaration
public bool HasData() const
Returns
bool

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

TryGetSurfaceData(const Guid& brushId, int32 brushSurfaceIndex, SurfaceData& outData)

Tries the get the brush surface data (may fail if data is missing or given brush surface doesn't result with any triangle).

Declaration
public bool TryGetSurfaceData(const Guid& brushId, int32 brushSurfaceIndex, SurfaceData& outData)
Parameters
Guid brushId

The brush identifier.
int32 brushSurfaceIndex

Index of the brush surface.
SurfaceData outData

The output data.
Returns
bool

True if found data, otherwise false.