gen_box_object_model_3dT_gen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3d (Operator)
gen_box_object_model_3dT_gen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3d — Create a 3D object model that represents a box.
Signature
void GenBoxObjectModel3d(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 void HOperatorSet.GenBoxObjectModel3d(HTuple pose, HTuple lengthX, HTuple lengthY, HTuple lengthZ, out HTuple objectModel3D)
static HObjectModel3D[] HObjectModel3D.GenBoxObjectModel3d(HPose[] pose, HTuple lengthX, HTuple lengthY, HTuple lengthZ)
void HObjectModel3D.GenBoxObjectModel3d(HPose pose, double lengthX, double lengthY, double lengthZ)
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]) -> HHandle
Description
gen_box_object_model_3dgen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3d creates a box-shaped 3D primitive, i.e.,
a 3D object model that represents a box. The box is specified by a
PosePosePoseposepose and the side lengths LengthXLengthXLengthXlengthXlength_x, LengthYLengthYLengthYlengthYlength_y, and
LengthZLengthZLengthZlengthZlength_z along the respective axis of the pose. The handle of
the resulting 3D object model is returned by parameter
ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_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
- 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
PosePosePoseposepose (input_control) pose(-array) → HPose, HTupleSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
The pose that describes the position and
orientation of the box. The pose has its
origin in the center of the box.
LengthXLengthXLengthXlengthXlength_x (input_control) number(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
The length of the box along the x-axis.
LengthYLengthYLengthYlengthYlength_y (input_control) number(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
The length of the box along the y-axis.
Number of elements:
LengthY == LengthX
LengthZLengthZLengthZlengthZlength_z (input_control) number(-array) → HTupleMaybeSequence[float]HTupleHtuple (real) (double) (double) (double)
The length of the box along the z-axis.
Number of elements:
LengthZ == LengthX
ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d (output_control) object_model_3d(-array) → HObjectModel3D, HTupleSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the resulting 3D object model.
Result
gen_box_object_model_3dgen_box_object_model_3dGenBoxObjectModel3dGenBoxObjectModel3dgen_box_object_model_3d returns 2 (
H_MSG_TRUE)
if all parameters
are correct. If necessary, an exception is raised.
Possible Predecessors
smallest_bounding_box_object_model_3dsmallest_bounding_box_object_model_3dSmallestBoundingBoxObjectModel3dSmallestBoundingBoxObjectModel3dsmallest_bounding_box_object_model_3d
Possible Successors
get_object_model_3d_paramsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParamsget_object_model_3d_params,
sample_object_model_3dsample_object_model_3dSampleObjectModel3dSampleObjectModel3dsample_object_model_3d,
clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dclear_object_model_3d
See also
gen_cylinder_object_model_3dgen_cylinder_object_model_3dGenCylinderObjectModel3dGenCylinderObjectModel3dgen_cylinder_object_model_3d,
gen_sphere_object_model_3dgen_sphere_object_model_3dGenSphereObjectModel3dGenSphereObjectModel3dgen_sphere_object_model_3d,
gen_sphere_object_model_3d_centergen_sphere_object_model_3d_centerGenSphereObjectModel3dCenterGenSphereObjectModel3dCentergen_sphere_object_model_3d_center,
gen_plane_object_model_3dgen_plane_object_model_3dGenPlaneObjectModel3dGenPlaneObjectModel3dgen_plane_object_model_3d
Module
3D Metrology