Encapsulates the configuration of a field shape. More...

#include <MeasurementFieldConfig.h>

Collaboration diagram for optris::FieldShapeConfig:

Static Public Member Functions
static OTC_SDK_API void	validate (FieldShapeConfig &config)
	Validates the field shape configuration.

Public Attributes
FieldShape	type = FieldShape::Rectangle
	Type of the field shape.

Vector2f	position = {0.F, 0.F}
	Center point for rectangular and elliptical fields or the origin of of the vertex coordinates for polygonal and spline based fields.

Vector2f	dimension = {0.F, 0.F}
	Dimension for rectangular and elliptical fields. Ignored for polygonal and spline based fields.

std::vector< Vector2f >	vertices
	Vertices for polygonal and spline based fields. Ignored for rectangular and elliptical fields.

bool	normalized = false
	Specifies whether the provided position, dimension and vertices are pixel coordinates or are normalized to the range [0, 1] relative to the current frame dimensions.

Detailed Description

Encapsulates the configuration of a field shape.

Member Function Documentation

◆ validate()

static OTC_SDK_API void optris::FieldShapeConfig::validate ( FieldShapeConfig & config )

static

Validates the field shape configuration.

Parameters

[in,out] config to validate.

Exceptions

SDKException if the configuration is invalid.

Member Data Documentation

◆ normalized

bool optris::FieldShapeConfig::normalized = false

Specifies whether the provided position, dimension and vertices are pixel coordinates or are normalized to the range [0, 1] relative to the current frame dimensions.

Only one format for position, dimension and vertices can be used. There is no mixing and matching.

◆ vertices

std::vector<Vector2f> optris::FieldShapeConfig::vertices

Vertices for polygonal and spline based fields. Ignored for rectangular and elliptical fields.

The vertices need to be defined relative to the point of origin specified by position.

The documentation for this struct was generated from the following file:

MeasurementFieldConfig.h