Glyph Version 3.18.3 |
pw:: SourceEntityBase type for all source entities Derives FromSummary
getByName
This action gets a source entity using the name. Parameters
ReturnsThis action returns a pw::SourceEntity object. ExampleThis example shows how to get a source entity named src-1 in order to find the begin spacing of the source Code set src(1) [pw::SourceEntity getByName "src-1"] Output src-1 has begin spacing of 0.1. getBySequence
This action gets a source entity using the sequence number. Parameters
ReturnsThis action returns a pw::SourceEntity object. NotesThis function is extremely inefficient for querying the entire source system. It is much more efficient to call pw::Source.getAll and simply index into the returned list. ExampleCode set src [pw::SourceEntity getBySequence 11] Output src-1 is of the type pw::SourcePoint. BeginSpacing
This default is the begin spacing of a source when it is created. Typefloat; (0.0, infinity) DefaultThe default value is 0.1. BeginDecay
This default is the begin decay of a source when it is created. Typefloat; [0.0, 1.0] DefaultThe default value is 0.5. EndSpacing
This default is the end spacing of a source when it is created. Typefloat; (0.0, infinity) DefaultThe default value is 0.1. EndDecay
This default is the end decay of a source when it is created. Typefloat; [0.0, 1.0] DefaultThe default value is 0.5. SpecificationType
This attribute is the specification type of the entity. Typestring with options < General | Constant | Parametric | AxisToPerimeter | CenterToPerimeter | PointDensity | AlignOnly >. Not all options are valid for all entities and setting this attribute to an invalid setting for these entities will have no effect. DefaultThe default specification type differs depending on the type of source, but usually it is Parametric. If that is not a valid type for the entity, then the default will be Constant. NoteThe current value of this attribute controls how the BeginSpacing, BeginDecay, EndSpacing and EndDecay attributes are used to control the size field produced by the source.
See AlsoUse isValidSpecificationType to check if a specification type is valid for an entity. BeginSpacing
This attribute is the begin spacing of a source. Typefloat; (0.0, infinity) DefaultThe default for this attribute is the value in the BeginSpacing default when the source was created. BeginDecay
This attribute is the begin decay of a source. Typefloat; [0.0, 1.0] DefaultThe default for this attribute is the value in the BeginDecay default when the source was created. EndSpacing
This attribute is the end spacing of a source. Typefloat; (0.0, infinity) DefaultThe default for this attribute is the value in the EndSpacing default when the source was created. EndDecay
This attribute is the end decay of a source. Typefloat; [0.0, 1.0] DefaultThe default for this attribute is the value in the EndDecay default when the source was created. transform
This action transforms this entity by the given matrix. The matrix is a list of 16 values, but in practice, the utility functions for transform matrices are generally used instead. Parameters
ReturnsThis action returns nothing. See AlsoisValidSpecificationType
This action returns whether the given specification type is valid for this entity. Parameters
ReturnsThis action returns a boolean, which is True if the specification type is supported. getValidSpecificationTypes
This action returns the valid specification types for this entity. ParametersNone ReturnsThis action returns a list of strings, where the strings will be from among the list of General, Constant, Parametric, AxisToPerimeter CenterToPerimeter, PointDensity, AlignOnly. getSpecificationXYZs
This action gets the representative xyz locations of specified spacing and decay values for this source Parametersnone ReturnsThis action returns a list of xyz vector values. isDefined
This action checks if this entity is defined. ParametersThis action has no parameters. ReturnsThis action returns a boolean, true if the entity is defined. isOGAAdaptation
This action checks if this entity was generated from overset assembly data. ParametersThis action has no parameters. ReturnsThis action returns a boolean, true if the entity was generated from overset assembly data. |
This action gets a source entity using the name.
pw::SourceEntity getByName ?-path path? name
This action gets a source entity using the sequence number.
pw::SourceEntity getBySequence number
This default is the begin spacing of a source when it is created.
pw::SourceEntity get/setDefault BeginSpacing value
This default is the begin decay of a source when it is created.
pw::SourceEntity get/setDefault BeginDecay value
This default is the end spacing of a source when it is created.
pw::SourceEntity get/setDefault EndSpacing value
This default is the end decay of a source when it is created.
pw::SourceEntity get/setDefault EndDecay value
This attribute is the specification type of the entity.
$entity get/setSpecificationType type
This action deletes this entity.
$entity delete
This action transforms this entity by the given matrix.
$entity transform matrix
This action returns whether the given specification type is valid for this entity.
$entity isValidSpecificationType type
This action returns the valid specification types for this entity.
$entity getValidSpecificationTypes
This action gets the representative xyz locations of specified spacing and decay values for this source
$entity getSpecificationXYZs
This action checks if this entity is defined.
$entity isDefined
This action checks if this entity was generated from overset assembly data.
$entity isOGAAdaptation
This action gets the description of how this entity was defined.
$entity getDescription
This action gets a list of all source entities.
pw::Source getAll ?< -grid entities | -shape entities >? ?-framework framework? ?-global?