Package org.robwork.sdurw_simulation

Class FrameGrabber25DPtr

java.lang.Object

org.robwork.sdurw_simulation.FrameGrabber25DPtr

public class FrameGrabber25DPtr
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FrameGrabber25D	__ref__()	Dereferencing operator.
void	delete()
FrameGrabber25D	deref()	The pointer stored in the object.
boolean	equals(FrameGrabber25D p)
static long	getCPtr(FrameGrabber25DPtr obj)
FrameGrabber25D	getDeref()	Member access operator.
double	getFieldOfViewY()	Returns the field of view measured around the y-axis.
long	getHeight()	returns the height of the image
PointCloud	getImage()	returns the image
double	getMaxDepth()	maximum depth that this framegrabber can handle
double	getMinDepth()	minimum depth that this framegrabber can handle
long	getWidth()	returns the width of the image
void	grab(FramePtr frame, State state)	this function grabs a image from the specialized source and copies it to the FrameGrabber25D image.
boolean	isNull()	checks if the pointer is null
boolean	isShared()	check if this Ptr has shared ownership or none ownership
void	resize(long width, long height)	resizes the image that this frameGrabber use.

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameGrabber25DPtr

public FrameGrabber25DPtr(long cPtr,
                          boolean cMemoryOwn)

FrameGrabber25DPtr

public FrameGrabber25DPtr()

Default constructor yielding a NULL-pointer.

FrameGrabber25DPtr

public FrameGrabber25DPtr(FrameGrabber25D ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(FrameGrabber25DPtr obj)

delete

public void delete()

deref

public FrameGrabber25D deref()

The pointer stored in the object.

__ref__

public FrameGrabber25D __ref__()

Dereferencing operator.

getDeref

public FrameGrabber25D getDeref()

Member access operator.

equals

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

getWidth

public long getWidth()

returns the width of the image

Returns:

the height of the image

getHeight

public long getHeight()

returns the height of the image

Returns:

the height of the image

getFieldOfViewY

public double getFieldOfViewY()

Returns the field of view measured around the y-axis.

Returns:

Field of view measured around y-axis in radians

resize

public void resize(long width,
                   long height)

resizes the image that this frameGrabber use. The colorcode will
default to the one that FrameGrabber25D was initialized with.

Parameters:

width - [in] width of image

height - [in] height of image

getImage

public PointCloud getImage()

returns the image

Returns:

the image

grab

public void grab(FramePtr frame,
                 State state)

this function grabs a image from the specialized source and
copies it to the FrameGrabber25D image.

getMaxDepth

public double getMaxDepth()

maximum depth that this framegrabber can handle

Returns:

maximum depth in meter

getMinDepth

public double getMinDepth()

minimum depth that this framegrabber can handle

Returns:

minimum depth in meter