Package org.robwork.sdurw_proximity
Class ProximityStrategyDataPtr
- java.lang.Object
-
- org.robwork.sdurw_proximity.ProximityStrategyDataPtr
-
public class ProximityStrategyDataPtr extends java.lang.ObjectPtr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description ProximityStrategyDataPtr()Default constructor yielding a NULL-pointer.ProximityStrategyDataPtr(long cPtr, boolean cMemoryOwn)ProximityStrategyDataPtr(ProximityStrategyData ptr)Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ProximityStrategyData__ref__()Dereferencing operator.ProximityStrategyDataCPtrcptr()voiddelete()ProximityStrategyDataderef()The pointer stored in the object.booleanequals(ProximityStrategyData p)doublegetAbs_err()absolute acceptable errorProximityCachePtrgetCache()Get the underlying cacheSWIGTYPE_p_std__pairT_rw__core__PtrT_rw__kinematics__Frame_t_rw__core__PtrT_rw__kinematics__Frame_t_tgetColidingFrames()get the the colliding framesCollisionResultgetCollisionData()get the result from the collision checkCollisionStrategy.QueryTypegetCollisionQueryType()Get the used Collision Query typestatic longgetCPtr(ProximityStrategyDataPtr obj)ProximityStrategyDatagetDeref()Member access operator.DistanceStrategy.DistanceStrategyResultgetDistanceData()get The result of a distance queryDistanceMultiStrategy.DistanceMultiStrategyResultgetMultiDistanceData()get The result of a multi distance querydoublegetMultiDistanceTolerance()get the tolerance used to treshold which distances are recorded and which are not.
point pairs that are closer than tolerance will be included in the
result.doublegetRel_err()relative acceptable errorSWIGTYPE_p_boolinCollision()was collision check in collisionbooleanisNull()checks if the pointer is nullbooleanisShared()check if this Ptr has shared ownership or none
ownershipvoidsetAbs_err(double value)absolute acceptable errorvoidsetCollisionQueryType(CollisionStrategy.QueryType qtype)set the Collision Query typevoidsetMultiDistanceTolerance(double tolerance)set the tolerance used to treshold which distances are recorded and which are not.
point pairs that are closer than tolerance will be included in the
result.voidsetRel_err(double value)relative acceptable error
-
-
-
Constructor Detail
-
ProximityStrategyDataPtr
public ProximityStrategyDataPtr(long cPtr, boolean cMemoryOwn)
-
ProximityStrategyDataPtr
public ProximityStrategyDataPtr()
Default constructor yielding a NULL-pointer.
-
ProximityStrategyDataPtr
public ProximityStrategyDataPtr(ProximityStrategyData ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(ProximityStrategyDataPtr obj)
-
delete
public void delete()
-
deref
public ProximityStrategyData deref()
The pointer stored in the object.
-
__ref__
public ProximityStrategyData __ref__()
Dereferencing operator.
-
getDeref
public ProximityStrategyData getDeref()
Member access operator.
-
equals
public boolean equals(ProximityStrategyData p)
-
isShared
public boolean isShared()
check if this Ptr has shared ownership or none
ownership- Returns:
- true if Ptr has shared ownership, false if it has no ownership.
-
isNull
public boolean isNull()
checks if the pointer is null- Returns:
- Returns true if the pointer is null
-
cptr
public ProximityStrategyDataCPtr cptr()
-
getCache
public ProximityCachePtr getCache()
Get the underlying cache- Returns:
- pointer to cache
-
getCollisionData
public CollisionResult getCollisionData()
get the result from the collision check- Returns:
- Result of Collision strategy if available
-
getColidingFrames
public SWIGTYPE_p_std__pairT_rw__core__PtrT_rw__kinematics__Frame_t_rw__core__PtrT_rw__kinematics__Frame_t_t getColidingFrames()
get the the colliding frames- Returns:
- the cooliding frames, if in collision else a pair of null
-
inCollision
public SWIGTYPE_p_bool inCollision()
was collision check in collision- Returns:
- true if in collision
-
setCollisionQueryType
public void setCollisionQueryType(CollisionStrategy.QueryType qtype)
set the Collision Query type- Parameters:
qtype- [in] the used Query type
-
getCollisionQueryType
public CollisionStrategy.QueryType getCollisionQueryType()
Get the used Collision Query type- Returns:
- Querytype
-
getDistanceData
public DistanceStrategy.DistanceStrategyResult getDistanceData()
get The result of a distance query- Returns:
- result of a distance query
-
getMultiDistanceData
public DistanceMultiStrategy.DistanceMultiStrategyResult getMultiDistanceData()
get The result of a multi distance query- Returns:
- result of a distance query
-
getMultiDistanceTolerance
public double getMultiDistanceTolerance()
get the tolerance used to treshold which distances are recorded and which are not.
point pairs that are closer than tolerance will be included in the
result.- Returns:
- The set tolerance
-
setMultiDistanceTolerance
public void setMultiDistanceTolerance(double tolerance)
set the tolerance used to treshold which distances are recorded and which are not.
point pairs that are closer than tolerance will be included in the
result.- Parameters:
tolerance- [in] set the stored tolerance
-
setRel_err
public void setRel_err(double value)
relative acceptable error
-
getRel_err
public double getRel_err()
relative acceptable error
-
setAbs_err
public void setAbs_err(double value)
absolute acceptable error
-
getAbs_err
public double getAbs_err()
absolute acceptable error
-
-