Glyph2 Version 2.18.0 |
pw:: TRexConditionT-Rex condition type Derives FromSummary
create
This action creates a new T-Rex condition object. ParametersNone ReturnsThis action returns a new pw::TRexCondition object. getByName
This action gets a T-Rex condition object with the given name. Parameters
ReturnsThis action returns a pw::TRexCondition object. getByEntities
This action returns a list of T-Rex condition objects, one for each input register. Parameters
ReturnsThis action retuns a list of pw::TRexCondition objects. InformationIf a given register does not have a T-Rex condition assigned to it, the “Unspecified” T-Rex condition will be returned. However calling the getRegisters action on the “Unspecified” T-Rex condition will only return the register if it is currently part of an active UnstructuredSolver mode. getNames
This action gets a list of T-Rex condition names. ParametersNone ReturnsThis action returns the T-Rex condition names as a list of strings. AutomaticWallSpacing
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall. TypeThis attribute is a float with the range [0, infinity). DefaultThe default for this attribute is 0.1. Name
This attribute is the name of the T-Rex condition. TypeThis attribute is a string. DefaultThe default for this attribute is a uniquely generated name. ConditionType
This attribute is the condition type of the T-Rex condition. TypeThis attribute is a string with values < Off | Wall | Match | AdjacentGrid >. DefaultThe default for this attribute is Off. Spacing
This attribute is the spacing of the T-Rex condition. TypeThis attribute is a float. DefaultThe default for this attribute is 0.0. apply
This action applies this boundary condition to a set of entity registers. Parameters
ReturnsThis action returns nothing. getRegisters
This action returns the registers that this boundary condition has been applied to. Parameters
ReturnsThis action returns a list of registers. InformationIf this is the “Unspecified” T-Rex condition, the registers that will be returned are only those registers that are currently part of an active UnstructuredSolver mode. If this is called during an active solver mode, it will return only the registers that are active in the solver. This means that is may be an incomplete list of the registers using the boundary condition. getRegisterCount
This action returns the number of registers that this boundary condition has been applied to. Parameters
ReturnsThis action returns an integer value. InformationThis returns a count of all registers that use the boundary condition. If this is called while a solver mode is active, it includes both the registers that are active in the solver and registers not active in the solver. Note that the getRegisters function only returns the former and not the latter. |
This action creates a new T-Rex condition object.
pw::TRexCondition create
This action gets a T-Rex condition object with the given name.
pw::TRexCondition getByName name
This action returns a list of T-Rex condition objects, one for each input register.
pw::TRexCondition getByEntities register_list
This action gets a list of T-Rex condition names.
pw::TRexCondition getNames
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.
pw::TRexCondition get/setAutomaticWallSpacing spacing
This attribute is the name of the T-Rex condition.
$tc get/setName name
This attribute is the condition type of the T-Rex condition.
$tc get/setConditionType type
This attribute is the spacing of the T-Rex condition.
$tc get/setSpacing spacing
This action deletes this T-Rex condition.
$tc delete
This action applies this boundary condition to a set of entity registers.
$tc apply register_list
This action returns the registers that this boundary condition has been applied to.
$bc getRegisters ?-visibility onoff?
This action returns the number of registers that this boundary condition has been applied to.
$bc getRegisterCount ?-visibility onoff?