 | |
Axis | |
AxisWithLabelsNode shows one 3D axis with value labels and axis title shown as 3D text objects created with BitmapTextCreator.
Inheritance HierarchySystemObject
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreInitializedSceneComponent
Ab4d.SharpEngine.SceneNodesSceneNode
Ab4d.SharpEngine.SceneNodesGroupNode
Ab4d.SharpEngine.SceneNodesAxisWithLabelsBaseNode
Ab4d.SharpEngine.SceneNodesAxisWithLabelsNode
Ab4d.SharpEngine.CoreComponentBase
Ab4d.SharpEngine.CoreInitializedSceneComponent
Ab4d.SharpEngine.SceneNodesSceneNode
Ab4d.SharpEngine.SceneNodesGroupNode
Ab4d.SharpEngine.SceneNodesAxisWithLabelsBaseNode
Ab4d.SharpEngine.SceneNodesAxisWithLabelsNode
Namespace: Ab4d.SharpEngine.SceneNodes
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 4.0.9584+ba1aaa26d4181dd3fa8ed7b6398391d1affa36c8
SyntaxC#
public class AxisWithLabelsNode : AxisWithLabelsBaseNode
The AxisWithLabelsNode type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AxisWithLabelsNode(String, String) | Constructor |
| AxisWithLabelsNode(BitmapTextCreator, String, String) | Constructor |
| AxisWithLabelsNode(ICamera, String, String) | Constructor |
| AxisWithLabelsNode(BitmapTextCreator, ICamera, String, String) | Constructor |
| AxisWithLabelsNode(Vector3, Vector3, ICamera, String, String) | Constructor |
| AxisWithLabelsNode(BitmapTextCreator, Vector3, Vector3, ICamera, String, String) | Constructor |
Properties| Name | Description | |
|---|---|---|
 | AdjustFirstLabelPosition | When true, then the first label is moved up to prevent overlapping the first label with adjacent axis. The amount of movement is calculated by multiplying font size and the LabelAdjustmentFactor (0.45 by default). Default value is false. |
| AdjustLastLabelPosition | When true, then the last label is moved down to prevent overlapping the last label with adjacent axis. The amount of movement is calculated by multiplying font size and the LabelAdjustmentFactor (0.45 by default). Default value is false. |
| AxisTitleTextNode | Gets the SceneNode that shows axis title. |
| Camera | Gets or sets a camera that is showing the 3D scene (usually assigned to SceneView.Camera property). When this Camera object is set, then AxisWithLabelsNode subscribe to camera changes (when UpdateOnCameraChanges is true) and update the text directions based on the camera angles. When Camera object is not set, then text is oriented as it would be viewed with a camera with Heading = 0 and Attitude = 0. In this case it is recommended to call UpdateTextDirections(ICamera) to update the text directions. |
| IsRightToLeftText | Gets or sets a Boolean that specifies if text should be written in right to left direction. Default value is false, for left to right direction. |
| LabelAdjustmentFactor | Gets or sets a float that specifies a factor that is multiplied by FontSize and used to adjust the position of the first or last label when AdjustFirstLabelPosition or AdjustLastLabelPosition are used. Default value is 0.45. |
| LabelsBitmapTextCreator | Gets or sets a BitmapTextCreator that is used to generate the bitmap text for the axis labels. If this property is not set by the user, then AxisWithLabelsNode automatically use the default BitmapTextCreator (get by calling BitmapTextCreator.GetDefaultBitmapTextCreator). |
| TitleBitmapTextCreator | Gets or sets a BitmapTextCreator that is used to generate the bitmap text for the axis title. If this property is not set by the user, then AxisWithLabelsNode automatically use the default BitmapTextCreator (get by calling BitmapTextCreator.GetDefaultBitmapTextCreator). |
| UpdateOnCameraChanges | Gets or sets a Boolean that specifies if AxisWithLabelsNode subscribe to camera changes of the Camera changes and update the text directions on each camera change. By default, this value is true. When set to false, then it is recommended to manually call UpdateTextDirections to update the text directions. |
| ValueLabelsGroupNode | Gets the GroupNode that is a parent node to all text nodes used to show value labels. |
Methods| Name | Description | |
|---|---|---|
| Clone | |
 | Dispose | (Overrides GroupNodeDispose(Boolean)) |
| OnInitializeSceneResources | (Overrides GroupNodeOnInitializeSceneResources(Scene, VulkanDevice)) |
| OnTicksPositionsChanged |
OnTicksPositionsChanged is called when tick positions change.
(Overrides AxisWithLabelsBaseNodeOnTicksPositionsChanged) |
| OnUpdate |
Updates the axis if needed.
(Overrides AxisWithLabelsBaseNodeOnUpdate) |
| UpdateTextDirections | UpdateTextDirections method can be called when Camera property is set but UpdateOnCameraChanges is false. When called, it updates the directions of the text based on the current camera. |
| UpdateTextDirections(ICamera) | UpdateTextDirections method can be called when Camera property is not set, and we want to update the directions of the text based on the specified camera. |
Extension Methods| Name | Description | |
|---|---|---|
 | DumpHierarchy |
Writes the hierarchy of the GroupNode and its children into the Visual Studio Output window.
(Defined by Extensions) |
See Also