PyANGKernel.GKGroupingType¶

class GKGroupingType¶

GKGroupingType corresponds to a Grouping Category: a set of Groupings ( GKGroup ) of objects of the same type.

Synopsis¶

Methods¶

def __init__()
def addGroup()
def contains()
def getFilterType()
def getGroupingType()
def getGroups()
def getGroupsObjects()
def getInternalName()
def isExclusiveObjects()
def refreshStats()
def removeGroup()
def setExclusiveObjects()
def setFilterType()
def setGroupingType()
def setInternalName()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class GroupingType¶: Objects in groups are acquired as a manual list or as the contents of a polygon.

__init__()¶

addGroup(group)¶

Parameters:: group – GKGroup

Add a new group to this grouping

contains(obj)¶

Parameters:: obj – GKObject
Return type:: bool

Is the object in any group inside this grouping category?

static createGroupingType(iModel, iFilter)¶

Parameters:

iModel – GKModel
iFilter – GKType

Return type:

GKGroupingType

static findGroupingType(iModel, iFilter)¶

Parameters:

iModel – GKModel
iFilter – GKType

Return type:

GKGroupingType

getFilterType()¶

Return type:: GKType

Type of objects that we can group

getGroupingType()¶

Return type:: GroupingType

Objects in groups are acquired as a manual list or as the contents of a polygon.

getGroups()¶

Return type:: Dictionary with keys of type .uint and values of type GKObject.

Returns all the groups of this grouping.

getGroups(obj)

Parameters:: obj – GKObject
Return type:: .list of GKGroup

Returns the list of GKGroup that contain the specified GKObject (can be an empty list).

getGroupsObjects()¶

Return type:: .QSetGKObject

Returns all the objects in the groups of this grouping.

getInternalName()¶

Return type:: str

Gets the internal grouping type name

isExclusiveObjects()¶

Return type:: bool

If true, a GKObject cannot be contained in more than one GKGroup of this GKGroupingType .

refreshStats(originator[, createColumns=true])¶

Parameters:

originator – GKObject
createColumns – bool

Refresh grouping category statistics. Called during the simulation

refreshStats(originator, cols[, createColumns=true[, task=None]])

Parameters:

originator – GKObject
cols – .list of GKColumn
createColumns – bool
task – GKTask

Refresh grouping category statistics

removeGroup(group)¶

Parameters:: group – GKGroup

Removes a group from this grouping. The group is not deleted.

setExclusiveObjects(exclusive)¶

Parameters:: exclusive – bool

If true, a GKObject cannot be contained in more than one GKGroup of this GKGroupingType .

See also

isExclusiveObjects()

setFilterType(type)¶

Parameters:: type – GKType

Type of objects that we can group

setGroupingType(groupingType)¶

Parameters:: groupingType – GroupingType

Objects in groups are acquired as a manual list or as the contents of a polygon.

setInternalName(iname)¶

Parameters:: iname – str

Sets the internal (and unique) grouping type name.