Global actions for source entities
pw:: | Global actions for source entities |
Static Actions | |
save | This action saves all source entities in the native file format. |
getAll | This action gets a list of all source entities. |
getCount | This action gets the number of soure entities. |
getByName | This action gets a source entity using the name. |
getExtents | This action gets the extents of the source entities. |
getSize | This action gets the size at the given XYZ coordinates from source evaluation. |
getAutomaticSize | This action gets the size at the given XYZ coordinates from automatic (curvature-based) size field evaluation. |
import | This action creates a new source point cloud object imported from a file. |
pw::Source save ?-compress level? ?-noOverwrite? filename
This action saves all source entities in the native file format.
-compress level | This optional parameter sets the integer file compression level with the range [0, 9]. The default is 0. |
-noOverwrite | This optional flag is notification to not save if filename already exists. |
filename | This parameter is the full path and name string of the file to save. |
This action returns nothing.
This command supports progress updates.
For “-compress level”, 0 = no compression, 1 = minimum, and 9 = maximum. Higher levels of compression take longer to save.
pw::Source getAll ?< -grid entities | -shape entities >? ?-framework framework? ?-global?
This action gets a list of all source entities.
-grid entities | This optional parameter is a list of pw::GridEntity objects to limit the source entities returned to only be those that possibly effect these grid entities. |
-shape entities | This optional parameter is a list of pw::GridShape objects to limit the source entities returned to only be those that possibly effect these shape entities. |
-framework | If specified, this argument specifies which pw::Framework to query. If not specified, the active pw::Framework is used as the target. |
-global | If specified, the sources from all frameworks are collected. The return value will be a list of framework_entity. |
This action returns a list of pw::SourceEntity objects, or a list of framework_entity when -global is specified.
Only one of the -grid or -shape parameters can be given at the same time. If both are given, an error is returned.
pw::Source getCount
This action gets the number of soure entities.
This action has no parameters.
This action returns an integer value.
pw::Source getByName name
This action gets a source entity using the name.
name | This parameter is a name string. |
This action returns a pw::SourceEntity object.
pw::Source getExtents ?-enabledOnly? ?-visibleOnly?
This action gets the extents of the source entities.
-enabledOnly | This flag, if present, restricts the calculations to only enabled entities, regardless of their visibility. Enabled entities in off layers are included, for example. |
-visibleOnly | This flag, if present, restricts the calculations to only visible entities. |
This action returns a list of two vectors representing the min and max xyz points of the extents.
pw::Source getSize points background_spacing ?-include source_list? ?-exclude source_list? ?-calculationMethod method?
This action gets the size at the given XYZ coordinates from source evaluation.
points | This parameter is a list of vector point positions at which the size is requested. |
background_spacing | This parameter is the desired spacing far away from all sources. |
-include source_list | This optional parameter is a list of pw::SourceEntity objects to be included in the size field calculation. If not specified, all sources will be included. |
-exclude source_list | This optional parameter is a list of pw::SourceEntity objects to be excluded from the size field calculation. If not specified, nothing will be excluded. |
-calculationMethod method | This optional parameter is the string method that controls how spacing is calculated for size field point primitives with options < MinimumDistance | InverseDistance | BlendDistance | MinimumValue >. If not specified, MinimumDistance will be used. |
This action returns a list of float sizes at the point locations.
This action gets the size at the given XYZ coordinates from automatic (curvature-based) size field evaluation.
points | This parameter is a list of vector point positions at which the size is requested. |
background_spacing | This parameter is the desired spacing far away from all sources. |
decay_factor | This parameter is the desired decay factor. |
-maxAngularDeviation | This optional parameter is the desired maximum angular deviation used to compute the geometric curvature-based size field. |
-maxAbsoluteDeviation | This optional parameter is the desired maximum absolute deviation used to compute the geometric curvature-based size field. |
This action returns a list of float sizes at the point locations.
pw::Source import ?-type file_type? ?-report report_var? filename
This action creates a new source point cloud object imported from a file.
-type file_type | This optional parameter is the string file type of the file with options < Automatic | PCD >. The default is PCD (the only supported format). |
-report report_var | This optional parameter is a variable name to receive a string reporting the low-level details of the import. |
filename | This parameter is the string full path and name of the file to import. |
This command supports progress updates.
Automatic | determine the file type based on the filename extension |
PCD | Point Cloud Library file format |
This action returns a new pw::SourcePointCloud object.
This action saves all source entities in the native file format.
pw::Source save ?-compress level? ?-noOverwrite? filename
This action gets a list of all source entities.
pw::Source getAll ?< -grid entities | -shape entities >? ?-framework framework? ?-global?
This action gets the number of soure entities.
pw::Source getCount
This action gets a source entity using the name.
pw::Source getByName name
This action gets the extents of the source entities.
pw::Source getExtents ?-enabledOnly? ?-visibleOnly?
This action gets the size at the given XYZ coordinates from source evaluation.
pw::Source getSize points background_spacing ?-include source_list? ?-exclude source_list? ?-calculationMethod method?
This action creates a new source point cloud object imported from a file.
pw::Source import ?-type file_type? ?-report report_var? filename