Version: 8.3.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Restore presentation parameters and a tree of sub-shapes

Functions

def RestoreSubShapes
 Publish sub-shapes, standing for arguments and sub-shapes of arguments To be used from python scripts out of addToStudy() (non-default usage) More...
 
def RestoreGivenSubShapes
 Publish sub-shapes, standing for arguments and sub-shapes of arguments To be used from python scripts out of addToStudy() (non-default usage) More...
 

Detailed Description

Function Documentation

def RestoreSubShapes (   self,
  theObject,
  theArgs = [],
  theFindMethod = GEOM.FSM_GetInPlace,
  theInheritFirstArg = False,
  theAddPrefix = True 
)

Publish sub-shapes, standing for arguments and sub-shapes of arguments To be used from python scripts out of addToStudy() (non-default usage)

Parameters
theObjectpublished GEOM.GEOM_Object, arguments of which will be published
theArgslist of GEOM.GEOM_Object, operation arguments to be published. If this list is empty, all operation arguments will be published
theFindMethodmethod to search sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM.find_shape_method.
theInheritFirstArgset properties of the first argument for theObject. Do not publish sub-shapes in place of arguments, but only in place of sub-shapes of the first argument, because the whole shape corresponds to the first argument. Mainly to be used after transformations, but it also can be usefull after partition with one object shape, and some other operations, where only the first argument has to be considered. If theObject has only one argument shape, this flag is automatically considered as True, not regarding really passed value.
theAddPrefixadd prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
Returns
list of published sub-shapes

Example

References geomBuilder.myStudy, geomBuilder.RestoreGivenSubShapes(), and GEOM_Gen.RestoreSubShapesO().

def RestoreGivenSubShapes (   self,
  theObject,
  theArgs = [],
  theFindMethod = GEOM.FSM_GetInPlace,
  theInheritFirstArg = False,
  theAddPrefix = True 
)

Publish sub-shapes, standing for arguments and sub-shapes of arguments To be used from python scripts out of addToStudy() (non-default usage)

Parameters
theObjectpublished GEOM.GEOM_Object, arguments of which will be published
theArgslist of GEOM.GEOM_Object, operation arguments to be published. If this list is empty, all operation arguments will be published
theFindMethodmethod to search sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM::find_shape_method.
theInheritFirstArgset properties of the first argument for theObject. Do not publish sub-shapes in place of arguments, but only in place of sub-shapes of the first argument, because the whole shape corresponds to the first argument. Mainly to be used after transformations, but it also can be usefull after partition with one object shape, and some other operations, where only the first argument has to be considered. If theObject has only one argument shape, this flag is automatically considered as True, not regarding really passed value.
theAddPrefixadd prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
Returns
list of published sub-shapes

Example

References geomBuilder.ManageTransactions(), geomBuilder.myStudy, and GEOM_Gen.RestoreGivenSubShapesO().