Package org.robwork.sdurw_proximity

Class DistanceStrategy

java.lang.Object

org.robwork.sdurw_proximity.ProximityStrategy

org.robwork.sdurw_proximity.DistanceStrategy

public class DistanceStrategy
extends ProximityStrategy

This is an interface that defines methods for computing the minimum distance
between geometric objects. If geometry objects has been related to frames (see
ProximityStrategy) then distance functions computing the distance between the geometry
attached to frames can also be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistanceStrategy.DistanceStrategyFactory	A factory for a DistanceStrategy.
static class	DistanceStrategy.DistanceStrategyResult	DistanceResult contains basic information about the distance result between two sets of geometries.

Nested classes/interfaces inherited from class org.robwork.sdurw_proximity.ProximityStrategy

ProximityStrategy.ProximityStrategyFactory

Constructor Summary

Constructors

Constructor	Description
DistanceStrategy(long cPtr, boolean cMemoryOwn)

Method Summary

Modifier and Type	Method	Description
void	delete()
DistanceStrategy.DistanceStrategyResult	distance(FramePtr a, Transform3D wTa, FramePtr b, Transform3D wTb)	Calculates the distance between two given frames \mathcal{F}_a and \mathcal{F}_b Conditional comment: End of conditional comment.
DistanceStrategy.DistanceStrategyResult	distance(FramePtr a, Transform3D wTa, FramePtr b, Transform3D wTb, double threshold)	Calculates the distance between two given frames \mathcal{F}_a and \mathcal{F}_b if the distance are within threshold.
DistanceStrategy.DistanceStrategyResult	distance(FramePtr a, Transform3D wTa, FramePtr b, Transform3D wTb, double threshold, ProximityStrategyData data)	Calculates the distance between two given frames \mathcal{F}_a and \mathcal{F}_b if the distance are within threshold.
DistanceStrategy.DistanceStrategyResult	distance(FramePtr a, Transform3D wTa, FramePtr b, Transform3D wTb, ProximityStrategyData data)	Calculates the distance between two given frames \mathcal{F}_a and \mathcal{F}_b Conditional comment: End of conditional comment.
DistanceStrategy.DistanceStrategyResult	distance(ProximityModelPtr a, Transform3D wTa, ProximityModelPtr b, Transform3D wTb, double threshold, ProximityStrategyData data)	Calculates the distance between two given frames \mathcal{F}_a and \mathcal{F}_b if the distance are within threshold.
DistanceStrategy.DistanceStrategyResult	distance(ProximityModelPtr a, Transform3D wTa, ProximityModelPtr b, Transform3D wTb, ProximityStrategyData data)	Calculates the distance between two proximity models \mathcal{a} and \mathcal{b} Conditional comment: End of conditional comment.
static long	getCPtr(DistanceStrategy obj)

Methods inherited from class org.robwork.sdurw_proximity.ProximityStrategy

addGeometry, addGeometry, addGeometry, addModel, addModel, addModel, addModel, clear, clearFrame, clearFrames, createModel, destroyModel, getCPtr, getGeometries, getGeometryIDs, getModel, hasModel, removeGeometry, useThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DistanceStrategy

public DistanceStrategy(long cPtr,
                        boolean cMemoryOwn)

Method Detail

getCPtr

public static long getCPtr(DistanceStrategy obj)

delete

public void delete()

Overrides:

delete in class ProximityStrategy

distance

public DistanceStrategy.DistanceStrategyResult distance(FramePtr a,
                                                        Transform3D wTa,
                                                        FramePtr b,
                                                        Transform3D wTb)

Calculates the distance between two given frames \mathcal{F}_a and
\mathcal{F}_b
Conditional comment:

End of conditional comment.

Parameters:

a - [in] \mathcal{F}_a

wTa - [in] \robabx{w}{a}{\mathbf{T}}

b - [in] \mathcal{F}_b

wTb - [in] \robabx{w}{b}{\mathbf{T}}

Returns:

shortest distance if \mathcal{F}_a and \mathcal{F}_b are
separated and not in collision.

distance

public DistanceStrategy.DistanceStrategyResult distance(FramePtr a,
                                                        Transform3D wTa,
                                                        FramePtr b,
                                                        Transform3D wTb,
                                                        ProximityStrategyData data)

Calculates the distance between two given frames \mathcal{F}_a and
\mathcal{F}_b
Conditional comment:

End of conditional comment.

Parameters:

a - [in] \mathcal{F}_a

wTa - [in] \robabx{w}{a}{\mathbf{T}}

b - [in] \mathcal{F}_b

wTb - [in] \robabx{w}{b}{\mathbf{T}}

data -

Returns:

shortest distance if \mathcal{F}_a and \mathcal{F}_b are
separated and not in collision.

distance

public DistanceStrategy.DistanceStrategyResult distance(ProximityModelPtr a,
                                                        Transform3D wTa,
                                                        ProximityModelPtr b,
                                                        Transform3D wTb,
                                                        ProximityStrategyData data)

Calculates the distance between two proximity models \mathcal{a} and
\mathcal{b}
Conditional comment:

End of conditional comment.

Parameters:

a - [in] \mathcal{F}_a

wTa - [in] \robabx{w}{a}{\mathbf{T}}

b - [in] \mathcal{F}_b

wTb - [in] \robabx{w}{b}{\mathbf{T}}

data -

Returns:

shortest distance if \mathcal{F}_a and \mathcal{F}_b are
separated and not in collision.

distance

public DistanceStrategy.DistanceStrategyResult distance(FramePtr a,
                                                        Transform3D wTa,
                                                        FramePtr b,
                                                        Transform3D wTb,
                                                        double threshold)

Calculates the distance between two given frames \mathcal{F}_a and
\mathcal{F}_b if the distance are within threshold. If the distance
between the frames are larger than the threshold, the result will be inaccurate.
Conditional comment:

End of conditional comment.

Parameters:

a - [in] \mathcal{F}_a

wTa - [in] \robabx{w}{a}{\mathbf{T}}

b - [in] \mathcal{F}_b

wTb - [in] \robabx{w}{b}{\mathbf{T}}

threshold - [in] threshold for distance calculations

Returns:

shortest distance if \mathcal{F}_a and \mathcal{F}_b are
separated and not in collision.

distance

public DistanceStrategy.DistanceStrategyResult distance(FramePtr a,
                                                        Transform3D wTa,
                                                        FramePtr b,
                                                        Transform3D wTb,
                                                        double threshold,
                                                        ProximityStrategyData data)

Calculates the distance between two given frames \mathcal{F}_a and
\mathcal{F}_b if the distance are within threshold. If the distance
between the frames are larger than the threshold, the result will be inaccurate.

Parameters:

a - [in] \mathcal{F}_a

wTa - [in] \robabx{w}{a}{\mathbf{T}}

b - [in] \mathcal{F}_b

wTb - [in] \robabx{w}{b}{\mathbf{T}}

threshold - [in] threshold for distance calculations

data -

Returns:

shortest distance if \mathcal{F}_a and \mathcal{F}_b are
separated and not in collision.

distance

public DistanceStrategy.DistanceStrategyResult distance(ProximityModelPtr a,
                                                        Transform3D wTa,
                                                        ProximityModelPtr b,
                                                        Transform3D wTb,
                                                        double threshold,
                                                        ProximityStrategyData data)

Calculates the distance between two given frames \mathcal{F}_a and
\mathcal{F}_b if the distance are within threshold. If the distance
between the frames are larger than the threshold, the result will be inaccurate.
Conditional comment:

End of conditional comment.

Parameters:

a - [in] \mathcal{F}_a

wTa - [in] \robabx{w}{a}{\mathbf{T}}

b - [in] \mathcal{F}_b

wTb - [in] \robabx{w}{b}{\mathbf{T}}

threshold - [in] threshold for distance calculations

data -

Returns:

shortest distance if \mathcal{F}_a and \mathcal{F}_b are
separated and not in collision.