Category Mechanism Design, Object ProKinDrag

Function ProKinDragEnvironmentSet


Description
this function setups the environment for subsequenmt dragging and reconnect operations. Environment can be set / reset several times after ProKinDragStart() is called.
Synopsis
#include <ProKinDrag.h>
ProErrorProKinDragEnvironmentSet(
const ProName snap_name
/* (In)
name of the existing snapshot which constraints will be active during drag. NULL can be passed instead. The snapshot will be checked for status (good / outdated /incomplete);
*/
const ProAsmcomppath* path
/* (In)
ProAsmcomppath of snapshot. NULL can be passed for top level snapshots.
*/
const ProKinDragType type
/* (In)
type of the drag to be performed.
*/
const ProSelection refobject
/* (In)
a selection represented coordinate system (PRO_CSYS), part (PRO_PART) or body (PRO_MDO_BODY) for advanced drag. It is relevant for advanced drag types only. For all other drag types it is ignored, NULL should be passed instead. In part selection case takes coordinates of corresponded body.
*/
)
Returns
PRO_TK_NO_ERRORThe function was successful.
PRO_TK_OUTDATEDThe environment has been set, but the snapshot is outdated.
PRO_TK_INCOMPLETEThe environment has been set, but the snapshot is incomplete.
PRO_TK_CHECK_OMITTEDThe environment has been set, but the snapshot validity check has not been performed, because outdated or incomplete snapshot has earlier been applied.
PRO_TK_BAD_INPUTSOne of the input parameters is bogus.
PRO_TK_GENERAL_ERRORThe function ProKinDragStart has not been called before.

Manual References:

  1. Assembly: Kinematic Dragging and Creating Snapshots: Connecting to a Kinematic Drag Session
  2. Assembly: Kinematic Dragging and Creating Snapshots: Connecting to a Kinematic Drag Session
  3. Assembly: Kinematic Dragging and Creating Snapshots: Performing Kinematic Drag

Sample Code References:

  1. pt_examples ( TestDrag.c )