CAE volume condition type
pw:: | CAE volume condition type |
Static Actions | |
create | This action creates a new volume condition object. |
getByName | This action gets a volume condition object with the given name |
getNames | This action gets a list of volume condition names. |
getPhysicalTypes | This action gets a list of physical type names. |
Instance Attributes | |
Name | This attribute is the name of the volume condition. |
Id | This attribute is the integer id of the volume condition. |
PhysicalType | This attribute is the physical type of the volume condition. |
Instance Actions | |
delete | This action deletes this volume condition. |
apply | This action applies this volume condition to the given domains or blocks. |
getEntities | This action returns the entities that this volume condition has been applied to. |
getEntityCount | This action returns the number of entities that this volume condition has been applied to. |
getScalarNames | This action gets the volume condition scalar names. |
getScalarValue | This action gets the value of a volume condition scalar. |
setScalarValue | This action sets the value of a volume condition scalar. |
deleteScalar | This action deletes a user-defined volume condition scalar. |
pw::VolumeCondition create
This action creates a new volume condition object.
None
This action returns a new pw::VolumeCondition object.
pw::VolumeCondition getByName name
This action gets a volume condition object with the given name
name | This parameters is the string name of the volume condition to get. |
This action returns a pw::VolumeCondition object.
pw::VolumeCondition getNames
This action gets a list of volume condition names.
None
This action returns the volume condition names as a list of strings.
pw::VolumeCondition getPhysicalTypes
This action gets a list of physical type names.
None
This action retuns the physical type names as a list of strings.
$vc get/setName name
This attribute is the name of the volume condition.
This attribute is a string.
The default for this attribute is a uniquely generated name.
$vc get/setPhysicalType type
This attribute is the physical type of the volume condition.
This attribute is a string.
The default for this attribute is Unspecified.
$vc apply entity_list
This action applies this volume condition to the given domains or blocks.
entity_list | This parameter is a list of pw::Domain objects (for 2D) or pw::Block objects (for 3D). |
This action returns nothing.
$vc getEntities ?-visibility onoff?
This action returns the entities that this volume condition has been applied to.
-visibility onoff | This 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. |
This action returns a list of pw::Block objects when in 3D mode, and a list of pw::Domain objects when in 2D mode.
$vc getEntityCount ?-visibility onoff?
This action returns the number of entities that this volume condition has been applied to.
-visibility onoff | This 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. |
This action returns an integer value.
$vc getScalarNames
This action gets the volume condition scalar names.
None
This action returns the scalar namse as list of strings.
$vc deleteScalar name
This action deletes a user-defined volume condition scalar.
name | This parameter is the string name of the scalar to delete. |
This action returns nothing.
This action creates a new volume condition object.
pw::VolumeCondition create
This action gets a volume condition object with the given name
pw::VolumeCondition getByName name
This action gets a list of volume condition names.
pw::VolumeCondition getNames
This action gets a list of physical type names.
pw::VolumeCondition getPhysicalTypes
This attribute is the name of the volume condition.
$vc get/setName name
This attribute is the integer id of the volume condition.
$vc get/setId id
This attribute is the physical type of the volume condition.
$vc get/setPhysicalType type
This action deletes this volume condition.
$vc delete
This action applies this volume condition to the given domains or blocks.
$vc apply entity_list
This action returns the entities that this volume condition has been applied to.
$vc getEntities ?-visibility onoff?
This action returns the number of entities that this volume condition has been applied to.
$vc getEntityCount ?-visibility onoff?
This action gets the volume condition scalar names.
$vc getScalarNames
This action gets the value of a volume condition scalar.
$vc getScalarValue name
This action sets the value of a volume condition scalar.
$vc setScalarValue name value
This action deletes a user-defined volume condition scalar.
$vc deleteScalar name