Model.hm_getincludeisolationentitiesmark#

Model.hm_getincludeisolationentitiesmark(components, output_collectionset, isolate_special, reserved)#

Returns the entities referenced/cross-referenced by the selected components, for include file organization purposes.

Parameters:

  • components (Collection) – The collection containing the input component entities.

  • output_collectionset (CollectionSet) – The set of collections containing possibly multiple type of the related entities.

  • isolate_special (bool) – A flag indicating whether to force isolation of individual mass, rigid or joint elements containing only isolated nodes.

  • reserved (int) – Reserved for future development. Should be set to 0.

Returns:

Example#

Put the entities related to components with IDs 1 and 2 onto collection set#
import hm
import hm.entities as ent

model = hm.Model()

output = hm.CollectionSet(model)

model.hm_getincludeisolationentitiesmark(
    components=hm.Collection(model, ent.Component, [1, 2]),
    output_collectionset=output,
    isolate_special=0.0,
    reserved=0
)