class `VectorField`

Inherits: Resource, TVectorField<false>

Represents a three dimensional field of vectors.

It is represented by spatial bounds which are split into a grid of values with user-defined density, where each grid cell is assigned a vector.

Public

VectorField() = default

*********************************************************************

static HVectorField Create(const VECTOR_FIELD_DESC &desc, const Vector<Vector3> &values)

Creates a new vector field.

desc: Description of the vector field to create.
values: Values to assign to the vector field. Number of entries must match countX * countY * countZ.

static RTTIType *GetRttiStatic()

RTTIType *GetRtti() const override

Returns an interface you can use to access class' Run Time Type Information.

virtual ~TVectorField<IsRenderProxy>() = default

TextureType GetTexture() const

Returns the internal texture representing the vector field.

const VECTOR_FIELD_DESC &GetDesc() const

Returns a structure describing the properties of the object.

static SPtr<VectorField> CreatePtrInternal(const VECTOR_FIELD_DESC &desc, const Vector<Vector3> &values)

Same as create() excepts it creates a pointer to the vector field instead of a handle.

static SPtr<VectorField> CreateEmptyInternal()

Creates the resource without initializing it.

VectorField(const VECTOR_FIELD_DESC &desc, const Vector<Vector3> &values)

SPtr<render::RenderProxy> CreateRenderProxy() const override

Creates an object that contains render thread specific data and methods for this object.

Can be null if such object is not required.