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 default is the condition type of a T-Rex condition when created.
This default is the adaptation of a T-Rex condition when created.
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.
This attribute is the angle to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to Angle.
This attribute is the aspect ratio to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to AspectRatio or MaximumAspectRatio.
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 adaptation type of the T-Rex condition.
This attribute is the value of the T-Rex condition.
This action deletes this T-Rex condition.
This action applies this TRex boundary condition to a set of entities and/or 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 Defaults

ConditionType

pw::TRexCondition get/setDefault ConditionType type

This default is the condition type of a T-Rex condition when created.

Type

This default is a string with values < Off | Wall | Angle | Match | AdjacentGrid | AspectRatio | MaximumAspectRatio >.

Default

The default is Off.

Adaptation

pw::TRexCondition get/setDefault Adaptation type

This default is the adaptation of a T-Rex condition when created.

Type

This default is a string with values < Off | On >.

Default

The default is Off.

Static Attributes

AutomaticWallValue

pw::TRexCondition get/setAutomaticWallValue 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.

AutomaticAngleValue

pw::TRexCondition get/setAutomaticAngleValue angle

This attribute is the angle to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to Angle.

Type

This attribute is a float with the range [0, 45].

Default

The default for this attribute is 0.0.

AutomaticAspectRatioValue

pw::TRexCondition get/setAutomaticAspectRatioValue ratio

This attribute is the aspect ratio to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to AspectRatio or MaximumAspectRatio.

Type

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

Default

The default for this attribute is 10.0.

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 | Angle | Match | AdjacentGrid | AspectRatio | MaximumAspectRatio >.

Default

The default for this attribute is the value in the ConditionType default when the T-Rex condition was created.

Adaptation

$tc get/setAdaptation adapt

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

Type

This attribute is a string with values < Off | On >.

Default

The default for this attribute is the value in the Adaptation default when the T-Rex condition was created.

Value

$tc get/setValue value

This attribute is the value of the T-Rex condition.  If the condition type is Wall, the value is the spacing.  If the condition type is Angle, the value is the angle.  If the condtion type is AspectRatio or MaximumAspectRatio, the value is the aspect ratio

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_or_entity_list

This action applies this TRex boundary condition to a set of entities and/or entity registers.  If an entity is specified, the default boundary condition for that entity is set, but no registers that use that entity are affected.  The default boundary condition for an entity is applied when the entity is used in a new higher-level entity.

When applying boundary conditions to an entity, this action only sets the “default” condition for that entity.  The “default” condition is applied to all subsequent uses (registers) of that entity.  In comparison, when a boundary condition is applied to a register, this action sets the condition for both the register and changes the “default” condition for the entity.

Parameters

register_or_entity_listThis parameter is a list of pw::Connector objects or connector usage registers; and pw::Domain objects or domain usage 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/setDefault ConditionType type
This default is the condition type of a T-Rex condition when created.
pw::TRexCondition get/setDefault Adaptation type
This default is the adaptation of a T-Rex condition when created.
pw::TRexCondition get/setAutomaticWallValue spacing
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.
pw::TRexCondition get/setAutomaticAngleValue angle
This attribute is the angle to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to Angle.
pw::TRexCondition get/setAutomaticAspectRatioValue ratio
This attribute is the aspect ratio to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to AspectRatio or MaximumAspectRatio.
$tc get/setName name
This attribute is the name of the T-Rex condition.
$tc get/setValue value
This attribute is the value of the T-Rex condition.
$tc delete
This action deletes this T-Rex condition.
$tc apply register_or_entity_list
This action applies this TRex boundary condition to a set of entities and/or entity registers.
A register is the usage of a lower level entity in a higher level entity.
$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 float is a fractional number.
Connector type
Domain type
An integer is a whole number.