Package org.robwork.sdurw

Class ProximityFilterStrategyPtr

java.lang.Object

org.robwork.sdurw.ProximityFilterStrategyPtr

public class ProximityFilterStrategyPtr
extends java.lang.Object

Ptr stores a pointer and optionally takes ownership of the value.

Constructor Summary

Constructors

Constructor	Description
ProximityFilterStrategyPtr()	Default constructor yielding a NULL-pointer.
ProximityFilterStrategyPtr(long cPtr, boolean cMemoryOwn)
ProximityFilterStrategyPtr(ProximityFilterStrategy ptr)	Do not take ownership of ptr. ptr can be null. The constructor is implicit on purpose.

Method Summary

Modifier and Type	Method	Description
ProximityFilterStrategy	__ref__()	Dereferencing operator.
void	addGeometry(Frame frame, GeometryPtr geo)	Adds geometry associated to frame
void	addRule(ProximitySetupRule rule)	Adds a ProximitySetupRule
ProximityCachePtr	createProximityCache()	creates a FilterData object.
void	delete()
ProximityFilterStrategy	deref()	The pointer stored in the object.
boolean	equals(ProximityFilterStrategy p)
static long	getCPtr(ProximityFilterStrategyPtr obj)
ProximityFilterStrategy	getDeref()	Member access operator.
SWIGTYPE_p_ProximitySetup	getProximitySetup()	get the proximity setup that describe the include/exclude rules of this BroadPhaseStrategy
boolean	isNull()	checks if the pointer is null
boolean	isShared()	check if this Ptr has shared ownership or none ownership
void	removeGeometry(Frame frame, java.lang.String geoName)	Removes the geometric model with name geoName and which is associated with frame.
void	removeGeometry(Frame frame, GeometryPtr geo)	Removes the geometric model geo associated with Frame frame from this strategy.
void	removeRule(ProximitySetupRule rule)	Removes a ProximitySetupRule If the rule cannot be found, then noting happens.
void	reset(State state)	Reset
ProximityFilterPtr	update(State state)	Do an update
ProximityFilterPtr	update(State state, ProximityCachePtr data)	called once before acquirering all possibly colliding frame pairs in the workcell

Methods inherited from class java.lang.Object

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

Constructor Detail

ProximityFilterStrategyPtr

public ProximityFilterStrategyPtr(long cPtr,
                                  boolean cMemoryOwn)

ProximityFilterStrategyPtr

public ProximityFilterStrategyPtr()

Default constructor yielding a NULL-pointer.

ProximityFilterStrategyPtr

public ProximityFilterStrategyPtr(ProximityFilterStrategy ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(ProximityFilterStrategyPtr obj)

delete

public void delete()

deref

public ProximityFilterStrategy deref()

The pointer stored in the object.

__ref__

public ProximityFilterStrategy __ref__()

Dereferencing operator.

getDeref

public ProximityFilterStrategy getDeref()

Member access operator.

equals

public boolean equals(ProximityFilterStrategy 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

reset

public void reset(State state)

Reset

Parameters:

state - [in] the state.

createProximityCache

public ProximityCachePtr createProximityCache()

creates a FilterData object. This is used for caching relavant data between calls to update

Returns:

update

public ProximityFilterPtr update(State state)

Do an update

Parameters:

state - [in] the state.

Returns:

update

public ProximityFilterPtr update(State state,
                                 ProximityCachePtr data)

called once before acquirering all possibly colliding
frame pairs in the workcell

Parameters:

state - [in] the state for which collision detection is performed.

data -

getProximitySetup

public SWIGTYPE_p_ProximitySetup getProximitySetup()

get the proximity setup that describe the include/exclude rules of this
BroadPhaseStrategy

Returns:

a reference to the ProximitySetup

addGeometry

public void addGeometry(Frame frame,
                        GeometryPtr geo)

Adds geometry associated to frame

Parameters:

frame - [in] Frame which has the geometry associated

geo - [in] Geometry

removeGeometry

public void removeGeometry(Frame frame,
                           GeometryPtr geo)

Removes the geometric model geo associated with
Frame frame from this strategy.

Parameters:

frame - [in] Frame which has the geometry associated

geo - [in] Geometry

removeGeometry

public void removeGeometry(Frame frame,
                           java.lang.String geoName)

Removes the geometric model with name geoName and which is associated with
frame.

Parameters:

frame - [in] Frame which has the geometry associated

geoName - [in] Name of geometry

addRule

public void addRule(ProximitySetupRule rule)

Adds a ProximitySetupRule

Parameters:

rule - [in] the rule to add.

removeRule

public void removeRule(ProximitySetupRule rule)

Removes a ProximitySetupRule
If the rule cannot be found, then noting happens.

Parameters:

rule - [in] the rule to remove.