pw:: VolumeCondition

CAE volume condition type

Derives From

pw::Object

Summary
CAE volume condition type
This action creates a new volume condition object.
This action gets a volume condition object with the given name
This action gets a list of volume condition names.
This action gets a list of physical type names.
This attribute is the name of the volume condition.
This attribute is the integer id of the volume condition.
This attribute is the physical type of the volume condition.
This action deletes this volume condition.
This action applies this volume condition to the given domains or blocks.
This action returns the entities that this volume condition has been applied to.
This action returns the number of entities that this volume condition has been applied to.
This action gets the volume condition scalar names.
This action gets the value of a volume condition scalar.
This action sets the value of a volume condition scalar.
This action deletes a user-defined volume condition scalar.

Static Actions

create

pw::VolumeCondition create

This action creates a new volume condition object.

Parameters

None

Returns

This action returns a new pw::VolumeCondition object.

getByName

pw::VolumeCondition getByName name

This action gets a volume condition object with the given name

Parameters

nameThis parameters is the string name of the volume condition to get.

Returns

This action returns a pw::VolumeCondition object.

getNames

pw::VolumeCondition getNames

This action gets a list of volume condition names.

Parameters

None

Returns

This action returns the volume condition names as a list of strings.

getPhysicalTypes

pw::VolumeCondition getPhysicalTypes

This action gets a list of physical type names.

Parameters

None

Returns

This action retuns the physical type names as a list of strings.

Instance Attributes

Name

$vc get/setName name

This attribute is the name of the volume condition.

Type

This attribute is a string.

Default

The default for this attribute is a uniquely generated name.

Id

$vc get/setId id

This attribute is the integer id of the volume condition.

Type

This attribute is an integer.

Default

The default for this attribute is the next available integer.

PhysicalType

$vc get/setPhysicalType type

This attribute is the physical type of the volume condition.

Type

This attribute is a string.

Default

The default for this attribute is Unspecified.

Instance Actions

delete

$vc delete

This action deletes this volume condition.

Parameters

None

Returns

This action returns nothing.

apply

$vc apply entity_list

This action applies this volume condition to the given domains or blocks.

Parameters

entity_listThis parameter is a list of pw::Domain objects (for 2D) or pw::Block objects (for 3D).

Returns

This action returns nothing.

getEntities

$vc getEntities ?-visibility onoff?

This action returns the entities that this volume condition has been applied to.

Parameters

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

Returns

This action returns a list of pw::Block objects when in 3D mode, and a list of pw::Domain objects when in 2D mode.

getEntityCount

$vc getEntityCount ?-visibility onoff?

This action returns the number of entities that this volume condition has been applied to.

Parameters

-visibility onoffThis optional flag controls whether or not the entity count is filtered by the entities’ visibility attributes.  If onoff is true, only visible entities are counted.  If onoff is false, only hidden entities are counted.

Returns

This action returns an integer value.

getScalarNames

$vc getScalarNames

This action gets the volume condition scalar names.

Parameters

None

Returns

This action returns the scalar namse as list of strings.

getScalarValue

$vc getScalarValue name

This action gets the value of a volume condition scalar.

Parameters

nameThis parameter is the string name of the scalar to get the value of.

Returns

This action returns the string value of the scalar.

setScalarValue

$vc setScalarValue name value

This action sets the value of a volume condition scalar.

Parameters

nameThis parameter is the string name of the scalar to set the value of.
valueThis parameter is the new scalar value as a string.

Returns

This action returns nothing.

deleteScalar

$vc deleteScalar name

This action deletes a user-defined volume condition scalar.

Parameters

nameThis parameter is the string name of the scalar to delete.

Returns

This action returns nothing.

pw::VolumeCondition create
This action creates a new volume condition object.
pw::VolumeCondition getByName name
This action gets a volume condition object with the given name
pw::VolumeCondition getNames
This action gets a list of volume condition names.
pw::VolumeCondition getPhysicalTypes
This action gets a list of physical type names.
$vc get/setName name
This attribute is the name of the volume condition.
$vc get/setId id
This attribute is the integer id of the volume condition.
$vc get/setPhysicalType type
This attribute is the physical type of the volume condition.
$vc delete
This action deletes this volume condition.
$vc apply entity_list
This action applies this volume condition to the given domains or blocks.
$vc getEntities ?-visibility onoff?
This action returns the entities that this volume condition has been applied to.
$vc getEntityCount ?-visibility onoff?
This action returns the number of entities that this volume condition has been applied to.
$vc getScalarNames
This action gets the volume condition scalar names.
$vc getScalarValue name
This action gets the value of a volume condition scalar.
$vc setScalarValue name value
This action sets the value of a volume condition scalar.
$vc deleteScalar name
This action deletes a user-defined volume condition scalar.
Base type for all glyph types
CAE volume condition type
A string is an array of characters.
An integer is a whole number.
Domain type
Block type