 | |
Model | |
ModelScalar is a helper class that can be used to scale selected 3D models.
Its ModelScalarGroupNode can show 3 axes with box and a center box that can be dragged by the user.
Inheritance HierarchyNamespace: Ab4d.SharpEngine.Utilities
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
SyntaxC#
public class ModelScalar : IDisposable
The ModelScalar type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ModelScalar(ManualInputEventsManager) | Initializes a new instance of the ModelScalar class with default axes. |
| ModelScalar(ManualInputEventsManager, Vector3, Vector3, Vector3) | Initializes a new instance of the ModelScalar class with providing custom axes. |
Properties| Name | Description | |
|---|---|---|
 | AxesLength | Gets or sets the length of axes that are shown by ModelScalar. Default value is 50. |
| CenterBoxColor | Gets or sets the color of center box. |
| CenterBoxScaleScreenDirection | Gets or sets a Vector2 that specifies in which direction (in screen coordinates) the center box scales the model up. Note that (0, 0) at top left so positive y direction is down. It is possible to increase or decrease the length of this vector to increase or decrease the speed of scaling when using the center box. Default value is up (0, -1). |
| CenterBoxWidth | Gets or sets the radius of the box at the end of the scalar box. Default value is 18. |
| CustomRenderingLayer | Gets or sets a custom RenderingLayer that will be used by all ModelNodes in this ModelScalar. For example, this is usually set to OverlayRenderingLayer. |
| InnerBoxWidth | Gets or sets the radius of the inner box. Default value is 4. |
| IsCenterBoxShown | Gets or sets a Boolean that specifies if the center box is shown. Default value is true. |
| IsEnabled | Gets or sets a Boolean that specifies if this ModelScalar is enabled. When disabled, then also the Visibility of ModelScalarGroupNode is set to Hidden. |
| IsXAxisShown | Gets or sets a Boolean that specifies if the X axis is shown. Default value is true. |
| IsYAxisShown | Gets or sets a Boolean that specifies if the Y axis is shown. Default value is true. |
| IsZAxisShown | Gets or sets a Boolean that specifies if the Z axis is shown. Default value is true. |
| ModelScalarGroupNode | Gets the GroupNode that can be added to the Scene and represents the 3D models that form the ModelScalar. |
| OuterBoxWidth | Gets or sets the radius of the box at the end of the scalar box. Default value is 12. |
| Position | Gets or sets Vector3 that specifies the position of the ModelScalar axis origin. |
| ScaleButtons | Gets or sets button(s) that need to be pressed to start scaling with this ModelScalar. Default value is left mouse button. |
| ScaleFactors | Gets the Vector3 that specifies the scale factors that were set up by dragging the axes in this ModelScalar. |
| SelectedMaterial | Gets or sets a Material that is used when pointer is over the arrow. If set to null, the arrow material is not changed. Default value is StandardMaterials.Yellow. |
| XAxisColor | Gets or sets the color of X axis. |
| XAxisVector | XAxisVector |
| YAxisColor | Gets or sets the color of Y axis. |
| YAxisVector | YAxisVector |
| ZAxisColor | Gets or sets the color of Z axis. |
| ZAxisVector | ZAxisVector |
Methods| Name | Description | |
|---|---|---|
| Dispose | Dispose unsubscribed from all pointer events and sets IsEnabled to false. |
 | OnModelScaled | OnModelScaled |
| OnModelScaleEnded | OnModelScaleEnded |
| OnModelScaleStarted | OnModelScaleStarted |
| SetRotation | SetRotation rotates the ModelScalar by the specified rotation angles. |
Events| Name | Description | |
|---|---|---|
 | ModelScaled | ModelScaled event is fired when model is scaled. Event handler can get the amount of scale by getting the values from the ScaleFactors in the ModelScaledEventArgs. |
| ModelScaleEnded | ModelScaleEnded event is fired when moving of the model is stopped. |
| ModelScaleStarted | ModelScaleStarted event is fired when scaling of the model is started. |
Fields| Name | Description | |
|---|---|---|
  | DefaultXAxis | X axis that is used by the default constructor. |
| DefaultYAxis | Y axis that is used by the default constructor. |
| DefaultZAxis | Z axis that is used by the default constructor. |
See Also