Short description
add_deformable_surface_model_reference_pointAddDeformableSurfaceModelReferencePointAddDeformableSurfaceModelReferencePointadd_deformable_surface_model_reference_pointT_add_deformable_surface_model_reference_point — Add a reference point to a deformable surface model.
Signature
add_deformable_surface_model_reference_point( deformable_surface_model DeformableSurfaceModel, real ReferencePointX, real ReferencePointY, real ReferencePointZ, out integer ReferencePointIndex )void AddDeformableSurfaceModelReferencePoint( const HTuple& DeformableSurfaceModel, const HTuple& ReferencePointX, const HTuple& ReferencePointY, const HTuple& ReferencePointZ, HTuple* ReferencePointIndex )static void HOperatorSet.AddDeformableSurfaceModelReferencePoint( HTuple deformableSurfaceModel, HTuple referencePointX, HTuple referencePointY, HTuple referencePointZ, out HTuple referencePointIndex )def add_deformable_surface_model_reference_point( deformable_surface_model: HHandle, reference_point_x: MaybeSequence[Union[float, int]], reference_point_y: MaybeSequence[Union[float, int]], reference_point_z: MaybeSequence[Union[float, int]] ) -> Sequence[int]
def add_deformable_surface_model_reference_point_s( deformable_surface_model: HHandle, reference_point_x: MaybeSequence[Union[float, int]], reference_point_y: MaybeSequence[Union[float, int]], reference_point_z: MaybeSequence[Union[float, int]] ) -> intHerror T_add_deformable_surface_model_reference_point( const Htuple DeformableSurfaceModel, const Htuple ReferencePointX, const Htuple ReferencePointY, const Htuple ReferencePointZ, Htuple* ReferencePointIndex )
HTuple HDeformableSurfaceModel::AddDeformableSurfaceModelReferencePoint( const HTuple& ReferencePointX, const HTuple& ReferencePointY, const HTuple& ReferencePointZ ) const
Hlong HDeformableSurfaceModel::AddDeformableSurfaceModelReferencePoint( double ReferencePointX, double ReferencePointY, double ReferencePointZ ) const
HTuple HDeformableSurfaceModel.AddDeformableSurfaceModelReferencePoint( HTuple referencePointX, HTuple referencePointY, HTuple referencePointZ )
int HDeformableSurfaceModel.AddDeformableSurfaceModelReferencePoint( double referencePointX, double referencePointY, double referencePointZ )
Description
The operator add_deformable_surface_model_reference_pointAddDeformableSurfaceModelReferencePoint adds
one or more reference points to the deformable surface model passed in
DeformableSurfaceModeldeformableSurfaceModeldeformable_surface_model.
The 3D coordinates of the reference points is passed in the parameters
ReferencePointXreferencePointXreference_point_x, ReferencePointYreferencePointYreference_point_y and
ReferencePointZreferencePointZreference_point_z.
The index of the new reference points is returned in
ReferencePointIndexreferencePointIndexreference_point_index.
Reference points are defined in model coordinates, i.e., in the coordinate
frame of the model parameter of create_deformable_surface_modelCreateDeformableSurfaceModel.
The operators
find_deformable_surface_modelFindDeformableSurfaceModel and
refine_deformable_surface_modelRefineDeformableSurfaceModel return the position of all
added reference points as found in the scene.
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Automatically parallelized on internal data level.
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
DeformableSurfaceModeldeformableSurfaceModeldeformable_surface_model (input_control, state is modified) deformable_surface_model → (handle)HTuple (HHandle)HDeformableSurfaceModel, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the deformable surface model.
ReferencePointXreferencePointXreference_point_x (input_control) real(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
x-coordinates of a reference point.
ReferencePointYreferencePointYreference_point_y (input_control) real(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
x-coordinates of a reference point.
ReferencePointZreferencePointZreference_point_z (input_control) real(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
x-coordinates of a reference point.
ReferencePointIndexreferencePointIndexreference_point_index (output_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)
Index of the new reference point.
Result
add_deformable_surface_model_reference_pointAddDeformableSurfaceModelReferencePoint returns 2 (H_MSG_TRUE) if all
parameters are correct. If necessary, an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
create_deformable_surface_modelCreateDeformableSurfaceModel, read_deformable_surface_modelReadDeformableSurfaceModel
Possible successors
find_deformable_surface_modelFindDeformableSurfaceModel, refine_deformable_surface_modelRefineDeformableSurfaceModel, write_deformable_surface_modelWriteDeformableSurfaceModel
See also
create_deformable_surface_modelCreateDeformableSurfaceModel, find_deformable_surface_modelFindDeformableSurfaceModel, refine_deformable_surface_modelRefineDeformableSurfaceModel
Module
3D Metrology