FlowEngine::DistanceConstraintInterface Class Reference

#include <DistanceConstraintInterface.h>

Public Member Functions
virtual FLE_DLL double	getWorldLength () const =0
virtual FLE_DLL Result	setEndpoints (const ControlPointConstraintInterface &cp1, const ControlPointConstraintInterface &cp2, int id1=-1, int id2=-1)=0
virtual FLE_DLL Result	setWorldLength (double length)=0
virtual FLE_DLL	~DistanceConstraintInterface ()=default

Detailed Description

Defines a distance constraint between two control points.

Distance constraints are always tied to two control points, because of this, the two control points must be different and must have been initialized and set up before setting them as endpoints of the distance constraint.

See also

ExampleMarkersBA.cpp

Constructor & Destructor Documentation

~DistanceConstraintInterface()

virtual FLE_DLL FlowEngine::DistanceConstraintInterface::~DistanceConstraintInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getWorldLength()

virtual FLE_DLL double FlowEngine::DistanceConstraintInterface::getWorldLength ( ) const

pure virtual

Returns

this control distance length w.r.t. the world reference system.

setEndpoints()

virtual FLE_DLL Result FlowEngine::DistanceConstraintInterface::setEndpoints ( const ControlPointConstraintInterface &  cp1, const ControlPointConstraintInterface &  cp2, int  id1 = -1, int  id2 = -1  )

pure virtual

Set the two endpoints of this distance constraint. The two control points must be different. Data is copied from the two control points, so the caller should not modify them after this call.

Parameters

[in]	cp1	the first endpoint of this distance constraint.
[in]	cp2	the second endpoint of this distance constraint.
[in]	id1	(optional) the index of the first endpoint in the distance constraint. See notes.
[in]	id2	(optional) the index of the second endpoint in the distance constraint. See notes.

Note

The two optional parameters id1 and id2 can be used to set the index of the corresponding control points in the distance constraint for cases where two or more distance constraints share the same control points. See the example ExampleBoundingBoxMarkers.

Returns

One of the following result codes:

• Result::Success – if the endpoints have been set successfully.
• Result::InvalidArgument –
  • if cp1 and cp2 are the same control point.

setWorldLength()

virtual FLE_DLL Result FlowEngine::DistanceConstraintInterface::setWorldLength ( double  length )

pure virtual

Set the length of this distance constraint w.r.t. the world reference system.

Parameters

[in]

length

the length of this distance constraint w.r.t. the world reference system. The valid range is [0, inf).

Returns

One of the following result codes:

• Result::Success – if the new length has been set successfully.
• Result::InvalidArgument – if length is not in the valid range.