ApiLocationTools Class
Helper class to work with locations
Definition
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public class ApiLocationTools- Inheritance
- Object ApiLocationTools
Properties
Methods
| CircleToPolygon | Converts a specified zone from a circle to a polygon |
| CircleToRectangle | Converts a specified zone from a circle to a rectangle |
| ClearCropRect | Resets the cropping of a specified LocationImage |
| CreateAnchor | Creates an anchor of a specified LocationObject at a specified position |
| CreateTransformer | Creates a transformer object to enable transformation mode for LocationObjects |
| EnsureWritable | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetImageCropRect | Gets the cropping rectangle of a specified LocationImage |
| GetLocalBoundingBox | Gets the local bounding box of a specific LocationObject |
| GetLocalVertices | Gets a list of points containing the coordinates for the local vertices |
| GetLocationBitmap | Gets the rendered bitmap for the current location with a specified maxmimum size |
| GetPosition | Gets the position of a specific LocationObject |
| GetTransformedBoundingBox | Gets the transformed bounding box of a specific LocationObject |
| GetTransformedVertices | Gets a list of points containing the coordinates for the transformed vertices |
| GetTransformMatrix | Gets the transform matrix of a specified LocationObject |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| PolygonToCircle | Converts a specified zone from a polygon to a circle |
| PolygonToRectangle | Converts a specified zone from a polygon to a rectangle |
| RemoveAllAnchors | Removes all anchors of a specified AnchoredObjects |
| RemoveAnchor | Deletes a specified anchor |
| ResetAspectHorizontal | Resets the aspect ratio of a specified LocationImage in horizontal mode |
| ResetAspectVertical | Resets the aspect ratio of a specified LocationImage in vertical mode |
| ResetTransformation | Resets the transformation for a specified LocationObject. Sets the rotation to 0.0, the TransformXAxis to 1.0/0.0 and the TransformYAxis to 0.0/1.0 |
| SaveLocationAsJpeg | Saves the current location as a jpeg file with a specified filename, a maximum size and a specified quality level |
| SaveLocationAsPng | Saves the current location as a png file with a specified filename and a maximum size |
| SaveLocationAsXps | Saves the current location as an xps file with a specified filename |
| SetImage | Assigns a specified image asset to a specified LocationImage object |
| SetImageCropRect | Sets the cropping rectangle of a specified LocationImage with a specified rectangle. The cropping coordinates are from 0.0 to 1.0 for each axis |
| SetPosition | Sets the position of a LocationObject to a new point |
| SimplifyPath | Simplifies the path of a specified shape, thus reducing the points count along the path with a specified tolerance. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| ValidateChild |
Extension Methods
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |