FormIt C++ API  v23.0.0 (2023.0.0)
WSM::Utils::ObjectTypeFilter Struct Reference

Description

#include <interfaces.h>

Public Attributes

size_t minNumObjects = 1
 The minimum number of objects that must be selected to complete this selection. More...
 
bool singleObjectOnly = false
 Limit the selection to a single object. More...
 
bool vertices = false
 Which specific geometry types can be picked. More...
 
bool edges = false
 
bool faces = false
 
bool bodies = false
 
bool instances = false
 
bool meshes = false
 
bool mustBeTopLevel = false
 Converts any selection into its top level owner. More...
 
bool selectBodyIfAllSelected = true
 If all the Faces or Edges are selected, select the Body. More...
 
bool allowOwnedFaces = false
 Allows owned faces to be selected even though mustBeTopLevel is true. More...
 
bool mustSelectAllConnected = false
 Clobbers all other settings in this filter, mandates that any selection must include everything that is connected does not care about types or number. More...
 
bool allowsGroupGeometry = false
 The selected geometry can be from inside a group, used for edit in context selection of nested references, and for solar radiation. More...
 
bool restrictGroupGeometryToEditingPath = false
 If true, when allowsGroupGeometry is true, restricts the selection to grouped geometry that is in or below the editing path. More...
 
bool isSelectingProfile = false
 Selecting a profile means exactly one face or many edges, but not both. More...
 
bool allowSectionPlanes = false
 Section Planes are allowed. More...
 

Member Data Documentation

bool WSM::Utils::ObjectTypeFilter::allowOwnedFaces = false

Allows owned faces to be selected even though mustBeTopLevel is true.

Ignored when it is not true.

bool WSM::Utils::ObjectTypeFilter::allowSectionPlanes = false

Section Planes are allowed.

bool WSM::Utils::ObjectTypeFilter::allowsGroupGeometry = false

The selected geometry can be from inside a group, used for edit in context selection of nested references, and for solar radiation.

bool WSM::Utils::ObjectTypeFilter::bodies = false
bool WSM::Utils::ObjectTypeFilter::edges = false
bool WSM::Utils::ObjectTypeFilter::faces = false
bool WSM::Utils::ObjectTypeFilter::instances = false
bool WSM::Utils::ObjectTypeFilter::isSelectingProfile = false

Selecting a profile means exactly one face or many edges, but not both.

Both "edges" and "faces" members should be true.

bool WSM::Utils::ObjectTypeFilter::meshes = false
size_t WSM::Utils::ObjectTypeFilter::minNumObjects = 1

The minimum number of objects that must be selected to complete this selection.

bool WSM::Utils::ObjectTypeFilter::mustBeTopLevel = false

Converts any selection into its top level owner.

It is not necessary to set this when only selecting bodies. The primary use for this is selecting top level faces from their edges.

bool WSM::Utils::ObjectTypeFilter::mustSelectAllConnected = false

Clobbers all other settings in this filter, mandates that any selection must include everything that is connected does not care about types or number.

bool WSM::Utils::ObjectTypeFilter::restrictGroupGeometryToEditingPath = false

If true, when allowsGroupGeometry is true, restricts the selection to grouped geometry that is in or below the editing path.

This is used for APIs that pass the GroupInstancePath directly to WSM, which doesn't know about the editing path, only the history in which the operation is being performed.

bool WSM::Utils::ObjectTypeFilter::selectBodyIfAllSelected = true

If all the Faces or Edges are selected, select the Body.

bool WSM::Utils::ObjectTypeFilter::singleObjectOnly = false

Limit the selection to a single object.

bool WSM::Utils::ObjectTypeFilter::vertices = false

Which specific geometry types can be picked.


The documentation for this struct was generated from the following file: