Model.midsurface_set_not_a_plate_side

Model.midsurface_set_not_a_plate_side(collection, use_base_surfaces, functionality)

Changes the plate information for every surface on the input collection. The function can be used to set the surfaces to be:

• Plate edge

• Transition surface

• Not-a-trim surface

If the base surface information is to be taken into account, the function will also do a preliminary check whether the given set of surfaces includes any base surfaces or not. If there is any base surface present, the function will exit without doing anything. Base surfaces can only be parts of offset plates. They cannot be a part of planar plates, sweep plates, plate edges, transitions, or not-a-trim surfaces.

Note

Base surfaces can only be parts of offset plates. They cannot be a part of planar plates, sweep plates, plate edges, transitions, or not-a-trim surfaces.

Parameters:

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

• use_base_surfaces (int) –

  This specifies whether the user-defined base surfaces will be taken into account or not to specify the surface type. Valid values are:

  0 - Base surface information is not taken into account. There is no restriction as to which surfaces can become plate edges, transition surfaces or not-a-trim surfaces.

  1 - Base surface information is taken into account. If the input mark contains a base surface, the function will not do anything.

• functionality (int) –

  Specifies what non-plate are the surfaces in the input collection turned into:

  0 - Set all surfaces on the input mark to become transition surfaces

  1 - Set all surfaces on the input mark to become plate edges

  2 - Reserved for future development, do not use

  3 - Set all surfaces on the input mark to become not-a-trim surfaces

Example

Set the surfaces with IDs 5 - 7 to be transition surfaces , include a check for the input collection to contain base surfaces

import hm
import hm.entities as ent

model = hm.Model()

surface_collection = hm.Collection(model, ent.Surface, [5, 6, 7])

model.midsurface_set_not_a_plate_side(
    collection=surface_collection, use_base_surfaces=1, functionality=0
)