Object ProCombstate

Function ProCombstateRedefine


Description
redefine existing combined state.
Replacement in Object TOOLKIT: wfcCombState::RedefineCombState
Synopsis
#include <ProCombstate.h>
ProErrorProCombstateRedefine(
ProCombstate* cs_item
/* (In)
Combined state item to redefine.
*/
ProModelitem* ref_arr
/* (In)
ProArray of reference items to redefine. See ProCombstateDataGet for possible types of items in this array. The new references override the existing ones. If a reference shouldn't be changed it should be passed with same ID. Omit a reference for 'NO STATE', where comb state activation will not affect this aspect, and use id PRO_COMBSTATE_REF_MRU for Most Recently Used. The reference array must be non empty.
*/
ProCrossecClipOpt clip_opt
/* (In)
Cross section clipping option of a state.
*/
ProBool is_expld
/* (In)
State exploded/unexploded?
*/
)
Returns
PRO_TK_NO_ERRORCombined state redefined.
PRO_TK_BAD_INPUTSInvalid solid or cs_item.
PRO_TK_INVALID_TYPEInvalid references. Possible errors:
- The type of one of the references is not valid.
- Reference of some type appears twice or more.
- Id and type of a reference don't match.

Manual References:

  1. Core: Solids, Parts, and Materials: Combined States of a Solid
  2. Core: Solids, Parts, and Materials: Combined States of a Solid