pw:: TRexCondition

T-Rex condition type

Derives From

pw::Object

Summary
T-Rex condition type
This action creates a new T-Rex condition object.
This action gets a T-Rex condition object with the given name.
This action returns a list of T-Rex condition objects, one for each input register.
This action gets a list of T-Rex condition names.
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.
This attribute is the name of the T-Rex condition.
This attribute is the condition type of the T-Rex condition.
This attribute is the spacing of the T-Rex condition.
This action deletes this T-Rex condition.
This action applies this boundary condition to a set of entity registers.
This action returns the registers that this boundary condition has been applied to.
This action returns the number of registers that this boundary condition has been applied to.

Static Actions

create

pw::TRexCondition create

This action creates a new T-Rex condition object.

Parameters

None

Returns

This action returns a new pw::TRexCondition object.

getByName

pw::TRexCondition getByName name

This action gets a T-Rex condition object with the given name.

Parameters

nameThis parameter is the string name of the T-Rex condition to get.

Returns

This action returns a pw::TRexCondition object.

getByEntities

pw::TRexCondition getByEntities register_list

This action returns a list of T-Rex condition objects, one for each input register.

Parameters

register_listThis parameter is a list of registers.

Returns

This action retuns a list of pw::TRexCondition objects.

Information

If 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

pw::TRexCondition getNames

This action gets a list of T-Rex condition names.

Parameters

None

Returns

This action returns the T-Rex condition names as a list of strings.

Static Attributes

AutomaticWallSpacing

pw::TRexCondition get/setAutomaticWallSpacing spacing

This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.

Type

This attribute is a float with the range [0, infinity).

Default

The default for this attribute is 0.1.

Instance Attributes

Name

$tc get/setName name

This attribute is the name of the T-Rex condition.

Type

This attribute is a string.

Default

The default for this attribute is a uniquely generated name.

ConditionType

$tc get/setConditionType type

This attribute is the condition type of the T-Rex condition.

Type

This attribute is a string with values < Off | Wall | Match | AdjacentGrid >.

Default

The default for this attribute is Off.

Spacing

$tc get/setSpacing spacing

This attribute is the spacing of the T-Rex condition.

Type

This attribute is a float.

Default

The default for this attribute is 0.0.

Instance Actions

delete

$tc delete

This action deletes this T-Rex condition.

Parameters

None

Returns

This action returns nothing.

apply

$tc apply register_list

This action applies this boundary condition to a set of entity registers.

Parameters

register_listThis parameter is a list of registers.

Returns

This action returns nothing.

getRegisters

$bc getRegisters ?-visibility onoff?

This action returns the registers that this boundary condition has been applied to.

Parameters

-visibility onoffThis optional flag controls whether or not the register list is filtered by the entities’ visibility attributes.  If onoff is true, only registers with visible entities are returned.  If onoff is false, only registers with hidden entities are returned.

Returns

This action returns a list of registers.

Information

If 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

$bc getRegisterCount ?-visibility onoff?

This action returns the number of registers that this boundary condition has been applied to.

Parameters

-visibility onoffThis optional flag controls whether or not the register count is filtered by the visibility of the register entities.  If onoff is true, only the count of registers with visible entities are counted.  If onoff is false, only registers with hidden entities are counted.

Returns

This action returns an integer value.

Information

This 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.

pw::TRexCondition create
This action creates a new T-Rex condition object.
pw::TRexCondition getByName name
This action gets a T-Rex condition object with the given name.
pw::TRexCondition getByEntities register_list
This action returns a list of T-Rex condition objects, one for each input register.
pw::TRexCondition getNames
This action gets a list of T-Rex condition names.
pw::TRexCondition get/setAutomaticWallSpacing spacing
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.
$tc get/setName name
This attribute is the name of the T-Rex condition.
$tc get/setConditionType type
This attribute is the condition type of the T-Rex condition.
$tc get/setSpacing spacing
This attribute is the spacing of the T-Rex condition.
$tc delete
This action deletes this T-Rex condition.
$tc apply register_list
This action applies this boundary condition to a set of entity registers.
$bc getRegisters ?-visibility onoff?
This action returns the registers that this boundary condition has been applied to.
$bc getRegisterCount ?-visibility onoff?
This action returns the number of registers that this boundary condition has been applied to.
Base type for all glyph types
T-Rex condition type
A string is an array of characters.
A register is the usage of a lower level entity in a higher level entity.
A float is a fractional number.
An integer is a whole number.