Skip to content

FBoxPoint

struct FBoxPoint : public FPoint

A point in a box(continuous) space.

Conceptually a floating point vector

Dependencies: ConstPointVisitor, FPoint, PointVisitor

Inherits from: public FPoint

Public Interface

Constructors:

FBoxPoint

inline FBoxPoint()

Construct an empty BoxPoint.

Attributes: inline

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 22, column 1)

FBoxPoint

inline FBoxPoint(const TArray<float> &InValues)

Parameters:

NameTypeDefault
InValuesconst TArray<float> &

Attributes: inline

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 27, column 1)

FBoxPoint

inline FBoxPoint(std::initializer_list<float> InValues)

Parameters:

NameTypeDefault
InValuesstd::initializer_list<float>

Attributes: inline

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 33, column 1)

FBoxPoint

inline FBoxPoint(const float *Data, int Num)

Construct a BoxPoint from a raw array of floats.

Parameters:

  • Data (const float *) – [in] The raw array of floats, as a const ptr
  • Num (int) – [in] The size of the array

Attributes: inline

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 43, column 1)

FBoxPoint

inline FBoxPoint(int NumDims)

Construct a preallocated BoxPoint, with no values.

Parameters:

  • NumDims (int) – [in] The amount of memory to preallocate

Attributes: inline

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 52, column 1)

Destructor:

~FBoxPoint

inline virtual ~FBoxPoint()

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 67, column 9)

Public Functions:

operator[]

inline float operator[](int Index) const const

Get the value of the BoxPoint at the given index or dimension.

Returns: the value at the given index or dimension

Parameters:

  • Index (int) – The dimension to get the value at

Returns: float

Attributes: const, inline

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 62, column 7)

Add

inline void Add(float Value)

Add a value to the BoxPoint.

Adds a new dimension to the point

Parameters:

  • Value (float) – [in] The value to add

Attributes: inline

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 76, column 6)

Reset

inline virtual void Reset() override

Reset the values of the BoxPoint.

Clears the current values

Note: This is doesn’t reset the size of the array so subsequent calls to Add will not reallocate memory

Attributes: inline, virtual

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 84, column 6)

Accept

virtual void Accept(PointVisitor &Visitor) override

Parameters:

NameTypeDefault
VisitorPointVisitor &

Attributes: virtual

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 89, column 6)

Implementation: Schola/Source/Schola/Private/Common/Points/BoxPoint.cpp (lines 6-9)

Accept

virtual void Accept(ConstPointVisitor &Visitor) const override const

Parameters:

NameTypeDefault
VisitorConstPointVisitor &

Attributes: const, virtual

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 91, column 6)

Implementation: Schola/Source/Schola/Private/Common/Points/BoxPoint.cpp (lines 11-14)

Public Members:

TArray<float> Values

TArray<float> Values

the values of this point

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 17, column 8)

Used By

This type is used by:

Source: Schola/Source/Schola/Public/Common/Points/BoxPoint.h (line 11, column 1)