M-File Help: VREP_mirror

M-File Help: VREP_mirror | View code for VREP_mirror

# VREP_mirror

V-REP mirror object class

Mirror objects are MATLAB objects that reflect the state of objects in the V-REP environment. Methods allow the V-REP state to be examined or changed.

This abstract class is the root class for all V-REP mirror objects.

Methods throw exception if an error occurs.

## Methods

getname | get object name
setparam_bool | set object boolean parameter
setparam_int | set object integer parameter
setparam_float | set object float parameter
getparam_bool | get object boolean parameter
getparam_int | get object integer parameter
getparam_float | get object float parameter
remove | remove object from scene
display | display object info
char | convert to string

## Properties (read only)

h | V-REP integer handle for the object
name | Name of the object in V-REP
vrep | Reference to the V-REP connection object

## Notes

- This has nothing to do with mirror objects in V-REP itself which are shiny reflective surfaces.

## See also

VREP_obj, VREP_arm, VREP_camera, VREP_hokuyo

# VREP_mirror.VREP_mirror

Construct VREP_mirror object

obj = VREP_mirror(name) is a V-REP mirror object that represents the object named name in the V-REP simulator.

# VREP_mirror.char

Convert to string

OBJ.char() is a string representation the VREP parameters in human readable foramt.

## See also

VREP.display

# VREP_mirror.display

Display parameters

OBJ.display() displays the VREP parameters in compact format.

## Notes

- This method is invoked implicitly at the command line when the result of an expression is a VREP object and the command has no trailing semicolon.

## See also

VREP.char

# VREP_mirror.getname

Get object name

OBJ.getname() is the name of the object in the VREP simulator.

# VREP_mirror.getparam_bool

Get boolean parameter of V-REP object

OBJ.getparam_bool(id) is the boolean parameter with id of the corresponding V-REP object.

See also VREP_mirror.setparam_bool, VREP_mirror.getparam_int, VREP_mirror.getparam_float.

# VREP_mirror.getparam_float

Get float parameter of V-REP object

OBJ.getparam_float(id) is the float parameter with id of the corresponding V-REP object.

See also VREP_mirror.setparam_bool, VREP_mirror.getparam_bool, VREP_mirror.getparam_int.

# VREP_mirror.getparam_int

Get integer parameter of V-REP object

OBJ.getparam_int(id) is the integer parameter with id of the corresponding V-REP object.

See also VREP_mirror.setparam_int, VREP_mirror.getparam_bool, VREP_mirror.getparam_float.

# VREP_mirror.setparam_bool

Set boolean parameter of V-REP object

OBJ.setparam_bool(id, val) sets the boolean parameter with id to value val within the V-REP simulation engine.

See also VREP_mirror.getparam_bool, VREP_mirror.setparam_int, VREP_mirror.setparam_float.

# VREP_mirror.setparam_float

Set float parameter of V-REP object

OBJ.setparam_float(id, val) sets the float parameter with id to value val within the V-REP simulation engine.

See also VREP_mirror.getparam_float, VREP_mirror.setparam_bool, VREP_mirror.setparam_int.

# VREP_mirror.setparam_int

Set integer parameter of V-REP object

OBJ.setparam_int(id, val) sets the integer parameter with id to value val within the V-REP simulation engine.

See also VREP_mirror.getparam_int, VREP_mirror.setparam_bool, VREP_mirror.setparam_float.

© 1990-2014 Peter Corke.