Package org.robwork.sdurw_proximity

Class ProximitySetup

java.lang.Object

org.robwork.sdurw_proximity.ProximitySetup

public class ProximitySetup
extends java.lang.Object

Setup for the collision checker

The ProximitySetup contains the rules about which frames should be
checked against each other

Constructor Summary

Constructors

Constructor	Description
ProximitySetup()	Default constructor for when no excludes are described
ProximitySetup(long cPtr, boolean cMemoryOwn)
ProximitySetup(CollisionSetup csetup)
ProximitySetup(ProximitySetupRuleVector rules)	Constructs ProximitySetup with list of exclusions

Method Summary

Modifier and Type	Method	Description
void	addProximitySetupRule(ProximitySetupRule rule)
void	delete()
static ProximitySetup	get(PropertyMap map)
static ProximitySetup	get(WorkCell wc)
static ProximitySetup	get(WorkCellPtr wc)
static long	getCPtr(ProximitySetup obj)
java.lang.String	getFileName()
boolean	getLoadedFromFile()
ProximitySetupRuleVector	getProximitySetupRules()	Returns the exclude list
void	merge(ProximitySetup setup, java.lang.String prefix)	Combine setup of this and setup of b into this collision setup.
void	removeProximitySetupRule(ProximitySetupRule rule)
static void	set(ProximitySetup setup, PropertyMap map)
static void	set(ProximitySetup setup, WorkCellPtr wc)
void	setFileName(java.lang.String file_name)
void	setLoadedFromFile(boolean loaded_from_file)
void	setUseExcludeStaticPairs(boolean exclude)
void	setUseIncludeAll(boolean includeAll)
boolean	useExcludeStaticPairs()
boolean	useIncludeAll()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProximitySetup

public ProximitySetup(long cPtr,
                      boolean cMemoryOwn)

ProximitySetup

public ProximitySetup()

Default constructor for when no excludes are described

ProximitySetup

public ProximitySetup(CollisionSetup csetup)

ProximitySetup

public ProximitySetup(ProximitySetupRuleVector rules)

Constructs ProximitySetup with list of exclusions

Parameters:

rules - documentation missing !
Conditional comment:
End of conditional comment.

Method Detail

getCPtr

public static long getCPtr(ProximitySetup obj)

delete

public void delete()

addProximitySetupRule

public void addProximitySetupRule(ProximitySetupRule rule)

removeProximitySetupRule

public void removeProximitySetupRule(ProximitySetupRule rule)

getProximitySetupRules

public ProximitySetupRuleVector getProximitySetupRules()

Returns the exclude list

Returns:

the exclude list

merge

public void merge(ProximitySetup setup,
                  java.lang.String prefix)

Combine setup of this and setup of b into this collision setup.

useExcludeStaticPairs

public boolean useExcludeStaticPairs()

setUseExcludeStaticPairs

public void setUseExcludeStaticPairs(boolean exclude)

useIncludeAll

public boolean useIncludeAll()

setUseIncludeAll

public void setUseIncludeAll(boolean includeAll)

setLoadedFromFile

public void setLoadedFromFile(boolean loaded_from_file)

getLoadedFromFile

public boolean getLoadedFromFile()

setFileName

public void setFileName(java.lang.String file_name)

getFileName

public java.lang.String getFileName()

get

public static ProximitySetup get(WorkCell wc)

get

public static ProximitySetup get(WorkCellPtr wc)

get

public static ProximitySetup get(PropertyMap map)

set

public static void set(ProximitySetup setup,
                       WorkCellPtr wc)

set

public static void set(ProximitySetup setup,
                       PropertyMap map)