Skip to content

gen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3dT_gen_box_object_model_3d🔗

Short description🔗

gen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3dT_gen_box_object_model_3d — Create a 3D object model that represents a box.

Signature🔗

gen_box_object_model_3d( pose Pose, number LengthX, number LengthY, number LengthZ, out object_model_3d ObjectModel3D )void GenBoxObjectModel3d( const HTuple& Pose, const HTuple& LengthX, const HTuple& LengthY, const HTuple& LengthZ, HTuple* ObjectModel3D )static void HOperatorSet.GenBoxObjectModel3d( HTuple pose, HTuple lengthX, HTuple lengthY, HTuple lengthZ, out HTuple objectModel3D )def gen_box_object_model_3d( pose: Sequence[Union[int, float]], length_x: MaybeSequence[float], length_y: MaybeSequence[float], length_z: MaybeSequence[float] ) -> Sequence[HHandle]

def gen_box_object_model_3d_s( pose: Sequence[Union[int, float]], length_x: MaybeSequence[float], length_y: MaybeSequence[float], length_z: MaybeSequence[float] ) -> HHandleHerror T_gen_box_object_model_3d( const Htuple Pose, const Htuple LengthX, const Htuple LengthY, const Htuple LengthZ, Htuple* ObjectModel3D )

static HObjectModel3DArray HObjectModel3D::GenBoxObjectModel3d( const HPoseArray& Pose, const HTuple& LengthX, const HTuple& LengthY, const HTuple& LengthZ )

void HObjectModel3D::GenBoxObjectModel3d( const HPose& Pose, double LengthX, double LengthY, double LengthZ )

static HObjectModel3D[] HObjectModel3D.GenBoxObjectModel3d( HPose[] pose, HTuple lengthX, HTuple lengthY, HTuple lengthZ )

void HObjectModel3D.GenBoxObjectModel3d( HPose pose, double lengthX, double lengthY, double lengthZ )

Description🔗

gen_box_object_model_3dGenBoxObjectModel3d creates a box-shaped 3D primitive, i.e., a 3D object model that represents a box. The box is specified by a Poseposepose and the side lengths LengthXlengthXlength_x, LengthYlengthYlength_y, and LengthZlengthZlength_z along the respective axis of the pose. The handle of the resulting 3D object model is returned by parameter ObjectModel3DobjectModel3Dobject_model_3d.

Parameter Broadcasting🔗

This operator supports parameter broadcasting. This means that each parameter can be given as a tuple of length 1 or N. Parameters with tuple length 1 will be repeated internally such that the number of created items is always N.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters🔗

Poseposepose (input_control) pose(-array) → (real / integer)HTuple (double / Hlong)HPose, HTuple (double / int / long)Sequence[Union[int, float]]Htuple (double / Hlong)

The pose that describes the position and orientation of the box. The pose has its origin in the center of the box.

LengthXlengthXlength_x (input_control) number(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

The length of the box along the x-axis.

LengthYlengthYlength_y (input_control) number(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

The length of the box along the y-axis.

Number of elements: LengthY == LengthX

LengthZlengthZlength_z (input_control) number(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

The length of the box along the z-axis.

Number of elements: LengthZ == LengthX

ObjectModel3DobjectModel3Dobject_model_3d (output_control) object_model_3d(-array) → (handle)HTuple (HHandle)HObjectModel3D, HTuple (IntPtr)Sequence[HHandle]Htuple (handle)

Handle of the resulting 3D object model.

Result🔗

gen_box_object_model_3dGenBoxObjectModel3d returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

smallest_bounding_box_object_model_3dSmallestBoundingBoxObjectModel3d

Possible successors

get_object_model_3d_paramsGetObjectModel3dParams, sample_object_model_3dSampleObjectModel3d, clear_object_model_3dClearObjectModel3d

See also

gen_cylinder_object_model_3dGenCylinderObjectModel3d, gen_sphere_object_model_3dGenSphereObjectModel3d, gen_sphere_object_model_3d_centerGenSphereObjectModel3dCenter, gen_plane_object_model_3dGenPlaneObjectModel3d

Module🔗

3D Metrology