pw:: Entity

Entity type

Derives From

pw::Object

Summary

pw:: Entity	Entity type
Static Actions
getByName	This action gets an entity with the given name.
getExtents (static)	This action gets the extents of the given entities.
getOrientedExtents (static)	This action gets the oriented extents of the given entities.
sort	This action sorts the given entities.
cycleColors	This action sets the list of entities to the next color in the cycle.
transform	This action transforms the given entities by the given matrix.
project	This action projects the given entities onto database entities.
checkDelete	This action checks the results of deleting the given entities, without actually deleting the entities.
delete	This action deletes the given entities.
Instance Attributes
Name	This attribute is the name of the entity.
Color	This attribute is the color of the entity.
Transparency	This attribute is the transparency of the entity.
Enabled	This attribute is the enabled status of the entity.
Layer	This attribute is the layer that the entity is in.
Instance Actions
toggleEnabled	This action toggles the Enabled attribute of the entity.
getExtents	This action gets the extents of this entity.
getOrientedExtents	This action gets the oriented extents of this entity.
getTimeStamp	This action gets the timestamp of an entity.
getRenderAttribute	This action gets the named render attribute.
setRenderAttribute	This action sets the named render attribute.
getGroups	This action gets the groups that this entity is an explicit member of.
getFramework	This action returns the pw::Framework to which this entity belongs.
Render Attributes
ColorMode	This attribute is the color mode for rendering an entity.
SecondaryColor	This attribute is the secondary color of the entity.
SecondaryColorMode	This attribute is the secondary color mode for rendering an entity.
PointMode	This attribute is the point mode for rendering an entity.
FillMode	This attribute is the fill mode for rendering an entity.
LineMode	This attribute is the line mode for rendering an entity.
IsolineCount	This attribute is the isoline count of the entity.
TriangleDensity	This attribute is the triangle density for entity rendering.
LineDensity	This attribute is the line density for entity rendering.
LineWidth	This attribute is the line width for entity rendering.

getByName

pw::Entity getByName ?-path path? name

This action gets an entity with the given name.

Parameters

name	This parameter is a name string.
-path path	This parameter and its argument specify the path to the framework in which the database entity resides. The path argument must be a list of either pw::Framework objects or framework names. The path must start at the root framework, start at the active framework, or start at a child of the active framework. The active framework is used as the default if this parameter is not specified.

Returns

This action returns a pw::Entity object.

getExtents (static)

pw::Entity getExtents entities

This action gets the extents of the given entities.

Parameters

entities

This parameter is a list of pw::Entity objects to get the extents of.

Returns

This action returns a list of two vectors representing the min and max points of the extents.

Information

This command supports progress updates.

getOrientedExtents (static)

pw::Entity getOrientedExtents ?-frame widthDir heightDir? ?-tolerance tol? entities

This action gets the oriented extents of the given entities.

Parameters

-frame widthDir heightDir	This optional parameter specifies two direction vectors, one in the direction of the width and another in the direction of the height to get the oriented extents with respect to. If the height vector is not orthogonal to the width vector, it will be adjusted so that it is. If not given, the oriented extents with the minimum volume will be computed.
-tolerance tol	This optional parameter is the angle tolerance in degrees for determining the minimum volume oriented extents of the entities, with the default value being 1.0.
entities	This parameter is a list of pw::Entity objects to get the oriented extents of.

Returns

This action returns a list of four vectors representing min point, max point, width direction and height direction of the extents. The width and height directions are unit vectors parallel to the width and height of the extents. The length direction can be computed as the cross product of the width and height directions.

Information

This command supports progress updates.

sort

pw::Entity sort entities

This action sorts the given entities.

Parameters

entities

This parameter is a list of pw::Entity objects to sort.

Returns

This action returns a list of pw::Entity objects in sorted order.

Information

The sort order is based on the type of entity, the user specified sort order, and the creation order of the entities. The first criterion is the type, with the order being pw::Block objects, pw::Domain objects, pw::Connector objects, and then pw::DatabaseEntity objects. The second criterion is the user specified order, using the pw::Domain.setSortOrder and pw::Block.setSortOrder actions, with unspecified entities being listed after user specified entities. The third and final criterion is the creation order, with older entities listed first.

cycleColors

pw::Entity cycleColors entities

This action sets the list of entities to the next color in the cycle.

Parameters

entities

This parameter is the list of pw::Entity objects whose color attributes will be assigned from the current color cycle.

Returns

This action does not return anything.

Information

The color cycle is a static, predefined series of RGB color values. The first color assigned by this action is the next in the cycle after the last color assigned by the most recent execution of this action. That is, the color cycle does not reset after each execution.

project

pw::Entity project ?-type proj_type? ?-direction direction? ?-center center? ?-axis point normal? ?-fit tolerance? ?<-interior | -shape>? entities ?dbentities?

This action projects the given entities onto database entities.

Parameters

-type proj_type	This optional parameter is the string projection type to perform with options < ClosestPoint \| Linear \| SphericalIn \| SphericalOut \| CylindricalIn \| CylindricalOut >.
-direction direction	This optional parameter is the projection vector for linear projection. The default is determined by the entity and can be queried using <getDefaultProjectDirection>.
-center center	This optional parameter is the center point vector for spherical projection. The default is (0, 0, 0).
-axis point normal	This optional parameter is the axis defined by a point vector and normal vector used by cylindrical projection; The default point is (0, 0, 0) and the default normal is (1, 0, 0).
-fit tolerance	This is an optional parameter that is used to fit any curve-like entities. The default for this is 0 which means there is no fitting applied onto the projected curve. The valid range for this parameter is [0,infinity)
-interior	If this optional flag is present, only the interior of the entities are projected.
-shape	If this optional flag is present, the shape of the underlying curve of the connectors will be projected to the database and the original distribution will be reapplied after the projection. This option is only valid for connectors and/or structured domains.
entities	This parameter is a list of entities to project. Only objects of the following type can be projected: pw::Connector, pw::Domain, pw::Point, pw::Curve, pw::SourcePoint, and pw::SourceCurve. There may be further limitations based on how these objects are used, for instance edge curves cannot be projected.
dbentities	This parameter is the optional list of database curve and surface-like entities to project onto. If none are given, project to any currently enabled, visible database surface-like entities.

Returns

This action returns nothing.

Note

If the entities parameter contains any pw::Domain objects, it is an error to include any pw::Curve objects in the dbentities parameter.

checkDelete

pw::Entity checkDelete ?-freed freedVar? ?-unconstrained unconstrainedVar? ?-constraining constrainingVar? entities

This action checks the results of deleting the given entities, without actually deleting the entities.

Parameters

-freed freedVar	This parameter is a variable name to receive a list of the pw::Entity objects that the deleted entities depend on, that would be free of dependents after the deletion.
-unconstrained unconstrainedVar	This parameter is a variable name to receive a list of the pw::GridEntity objects that will become unconstrained after the deletion of the given entities and the freed entities if the -freed parameter is present.
-constraining constrainingVar	This parameter is a variable name to receive a list of the pw::DatabaseEntity objects that are given as entities but are constraining grid entities.
entities	This parameter is a list of pw::Entity objects to delete.

Returns

This action returns a list of the pw::Entity objects that would be deleted if the delete action was used with the given entities.

Information

This command supports progress updates.

Enabled

$entity get/setEnabled ?-parents? enable

This attribute is the enabled status of the entity.

Type

boolean

Parameters

-parents

This optional parameter specifies that if this entity is a pw::Model or pw::Block, then the entity’s parents will have their Enabled attribute set as well. It is only available when using setEnabled.

Default

true

Layer

$entity get/setLayer ?-parents? layer

This attribute is the layer that the entity is in.

Type

This attribute is an integer with the range [0, 1023].

Parameters

-parents

This optional parameter specifies that if this entity is a pw::Model or pw::Block, then the entity’s parents will have their Layer attribute set as well. It is only available when using setLayer.

Default

The current layer attribute of the display pw::Display.CurrentLayer

getOrientedExtents

$entity getOrientedExtents ?-frame widthDir heightDir? ?-tolerance tol?

This action gets the oriented extents of this entity.

Parameters

-frame widthDir heightDir	This optional parameter specifies two direction vectors, one in the direction of the width and another in the direction of the height to get the oriented extents with respect to. If the height vector is not orthogonal to the width vector, it will be adjusted so that it is. If not given, the oriented extents with the minimum volume will be computed.
-tolerance tol	This optional parameter is the angle tolerance in degrees for determining the minimum volume oriented extents of the entities, with the default value being 1.0.

Returns

Information

This command supports progress updates.

getTimeStamp

$entity getTimeStamp

This action gets the timestamp of an entity.

Parameters

none

Returns

This action returns a string representing the time in WWW MMM DD YYYY hh:mm:ss.f.i format where WWW is the 3-letter abbreviated day of the week, MMM is the 3-letter abbreviated month, DD is the space padded day of the month (1-31), YYYY is the year, hh is the 24 hour count (0-23), mm is the minute count (00-59), ss is the second count (00-59), f is the fractional second, and i is the increment on the time for stamps that occurred during the same second (0-max int value).

ColorMode

$entity get/setRenderAttribute ColorMode mode

This attribute is the color mode for rendering an entity.

Type

This attribute is a string with options < Automatic | Entity | Connectivity >.

Information

Automatic	entities are automatically colored according to their type.
Entity	use the value of the entity’s Color attribute.
Connectivity	entities are automatically colored according to their connection topology (free, lamina, manifold, or non-manifold).

The primary color is used for drawing lines when the <DisplayStyle> render attribute is set to Wireframe or Hiddenline. The secondary color is not used for these display styles.

The primary color is used to fill polygons when the <DisplayStyle> render attribute is set to Solid, Shaded, SolidWireframe, or ShadedWireframe. The secondary color is used for drawing lines in these display styles.

SecondaryColorMode

$entity get/setRenderAttribute SecondaryColorMode mode

This attribute is the secondary color mode for rendering an entity.

Type

This attribute is a string with options < Automatic | Entity | Connectivity >.

Information

The secondary color is used for drawing lines when the <DisplayStyle> render attribute is set to Solid, Shaded, SolidWireframe, or ShadedWireframe.

See ColorMode for additional mode value information.

PointMode

$entity get/setRenderAttribute PointMode mode

This attribute is the point mode for rendering an entity.

Type

This attribute is a string with options < None | All >.

Information

None	The points are not rendered.
All	All of the points are rendered.

FillMode

$entity get/setRenderAttribute FillMode mode

This attribute is the fill mode for rendering an entity.

Type

This attribute is a string with options < None | Flat | Shaded | HiddenLine >.

Information

None	The polygon interior is unfilled and transparent (invisible).
Flat	Render the polygon interior filled with a constant, non-gradient color. This produces a flat, uncontoured apperance.
Shaded	Render the polygon interior filled with a gradient color. This produces a more realistic, contoured appearance.
HiddenLine	Similar to Flat except that the fill color is the average of the background colors. This produces a hidden-line appearance.

Entities that do not have polygons ignore this render attribute.

LineMode

$entity get/setRenderAttribute LineMode mode

This attribute is the line mode for rendering an entity.

Type

This attribute is a string with options < All | Boundary | None >.

Information

All renders the interior and boundary lines. Boundary renders just the boundary lines. None renders no lines.

pw:: Entity

Derives From

Static Actions

getByName

Parameters

Returns

getExtents (static)

Parameters

Returns

Information

getOrientedExtents (static)

Parameters

Returns

Information

sort

Parameters

Returns

Information

See Also

cycleColors

Parameters

Returns

Information

transform

Parameters

Returns

project

Parameters

Returns

Note

checkDelete

Parameters

Returns

Information

delete

Parameters

Returns

Information

Instance Attributes

Name

Type

Default

Color

Type

Default

Transparency

Type

Default

Enabled

Type

Parameters

Default

Layer

Type

Parameters

Default

Instance Actions

toggleEnabled

Parameters

Returns

getExtents

Parameters

Returns

getOrientedExtents

Parameters

Returns

Information

getTimeStamp

Parameters

Returns

getRenderAttribute

Parameters

Returns

setRenderAttribute

Parameters

Returns

getGroups

Parameters

Returns

getFramework