Package org.robwork.sdurw_simulation
Class SimulatedCameraPtr
- java.lang.Object
-
- org.robwork.sdurw_simulation.SimulatedCameraPtr
-
public class SimulatedCameraPtr extends java.lang.ObjectPtr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description SimulatedCameraPtr()Default constructor yielding a NULL-pointer.SimulatedCameraPtr(long cPtr, boolean cMemoryOwn)SimulatedCameraPtr(SimulatedCamera 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 SimulatedCamera__ref__()Dereferencing operator.voidacquire()SimulatedCameraCPtrcptr()voiddelete()SimulatedCameraderef()The pointer stored in the object.booleanequals(SimulatedCamera p)CameraPtrgetCameraSensor()Get the camera sensor.static longgetCPtr(SimulatedCameraPtr obj)SimulatedCameragetDeref()Member access operator.FramegetFrame()get frame that this sensor is attached to.doublegetFrameRate()longgetHeight()ImagegetImage()java.lang.StringgetName()get name of this simulated sensorSensorPtrgetSensor()SensorPtrgetSensorHandle(SimulatorPtr sim)get a handle to controlling an instance of the simulated sensor in a specific
simulatorSensorModelPtrgetSensorModel()get the sensor model of this simulated sensor.StateStructurePtrgetStateStructure()Get the state structure.longgetWidth()booleaninitialize()booleanisImageReady()booleanisNull()checks if the pointer is nullbooleanisRegistered()Check if object has registered its state.booleanisShared()check if this Ptr has shared ownership or none
ownershipvoidregisterIn(State state)initialize this stateless data to a specific statevoidregisterIn(StateStructurePtr state)register this stateless object in a statestructure.voidreset(State state)voidsetFrameRate(double framerate)booleanstart()voidstop()voidunregister()unregisters all state data of this stateless objectvoidupdate(Simulator.UpdateInfo info, State state)
-
-
-
Constructor Detail
-
SimulatedCameraPtr
public SimulatedCameraPtr(long cPtr, boolean cMemoryOwn)
-
SimulatedCameraPtr
public SimulatedCameraPtr()
Default constructor yielding a NULL-pointer.
-
SimulatedCameraPtr
public SimulatedCameraPtr(SimulatedCamera ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(SimulatedCameraPtr obj)
-
delete
public void delete()
-
deref
public SimulatedCamera deref()
The pointer stored in the object.
-
__ref__
public SimulatedCamera __ref__()
Dereferencing operator.
-
getDeref
public SimulatedCamera getDeref()
Member access operator.
-
equals
public boolean equals(SimulatedCamera 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 SimulatedCameraCPtr cptr()
-
initialize
public boolean initialize()
-
start
public boolean start()
-
stop
public void stop()
-
acquire
public void acquire()
-
isImageReady
public boolean isImageReady()
-
getImage
public Image getImage()
-
getFrameRate
public double getFrameRate()
-
setFrameRate
public void setFrameRate(double framerate)
-
getWidth
public long getWidth()
-
getHeight
public long getHeight()
-
update
public void update(Simulator.UpdateInfo info, State state)
-
reset
public void reset(State state)
-
getSensor
public SensorPtr getSensor()
-
getCameraSensor
public CameraPtr getCameraSensor()
Get the camera sensor.- Returns:
- the sensor.
-
getName
public java.lang.String getName()
get name of this simulated sensor
-
getFrame
public Frame getFrame()
get frame that this sensor is attached to.- Returns:
- frame
-
getSensorModel
public SensorModelPtr getSensorModel()
get the sensor model of this simulated sensor.
-
getSensorHandle
public SensorPtr getSensorHandle(SimulatorPtr sim)
get a handle to controlling an instance of the simulated sensor in a specific
simulator- Parameters:
sim- [in] the simulator in which the handle is active
-
registerIn
public void registerIn(State state)
initialize this stateless data to a specific state- Parameters:
state- [in] the state in which to register the data.
Note: the data will be registered in the state structure of the state
and any copies or other instances of the state will therefore also
contain the added states.
-
registerIn
public void registerIn(StateStructurePtr state)
register this stateless object in a statestructure.
-
unregister
public void unregister()
unregisters all state data of this stateless object
-
getStateStructure
public StateStructurePtr getStateStructure()
Get the state structure.- Returns:
- the state structure.
-
isRegistered
public boolean isRegistered()
Check if object has registered its state.- Returns:
- true if registered, false otherwise.
-
-