 | |
Axes | |
AxesBoxVisual3D can show all 6 axes with tick lines and value labels.
It automatically switches and orients the shown axes.
AxesBoxVisual3D can show axis title and value labels as 3D text (when Is3DTextShown is true) or as 2D text (when Is3DTextShown is false).
To set the value ranges and tick steps, call the SetAxisDataRange(AxesBoxVisual3DAxisTypes, Double, Double, Double, Double, Boolean) method.
The individual axes can be get by XAxis1, XAxis2, YAxis1, YAxis2, ZAxis1 and ZAxis2.
Setting properties that are the same for all axes (for example AxisLineThickness) will change the same property on all 6 axes.
Individual properties can be changed by setting the XAxis1Title, IsXAxis1Visible or directly properties on the axis - for example: XAxis1.AxisTitle.
Inheritance HierarchySystemObject
System.Windows.ThreadingDispatcherObject
System.WindowsDependencyObject
System.Windows.Media.Media3DVisual3D
System.Windows.Media.Media3DModelVisual3D
Ab3d.VisualsBaseVisual3D
Ab3d.VisualsContentVisual3D
Ab3d.VisualsAxesBoxVisual3D
System.Windows.ThreadingDispatcherObject
System.WindowsDependencyObject
System.Windows.Media.Media3DVisual3D
System.Windows.Media.Media3DModelVisual3D
Ab3d.VisualsBaseVisual3D
Ab3d.VisualsContentVisual3D
Ab3d.VisualsAxesBoxVisual3D
Namespace: Ab3d.Visuals
Assembly: Ab3d.PowerToys (in Ab3d.PowerToys.dll) Version: 11.2.9104.2045
SyntaxC#
public class AxesBoxVisual3D : ContentVisual3D, IDisposable
The AxesBoxVisual3D type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AxesBoxVisual3D | Constructor |
| AxesBoxVisual3D(String) | Constructor |
Properties| Name | Description | |
|---|---|---|
 | AdjustFirstAndLastLabelPositions | When true, then the last label is moved down to prevent overlapping the last label with adjacent axis. Default value is false. |
| AxisLineColor | Gets or sets the color of the axis line. |
| AxisLineThickness | Gets or sets the thickness of the axis line in screen coordinates. Default value is 2. |
| AxisShowingStrategy | Gets or sets one of AxisShowingStrategies that defines how the axes will be automatically shown, hidden and positioned (StartAxisPosition and EndAxisPosition will be changed). Default value is FrontFacingPlanes. |
| AxisTitleBrush | Gets or sets the brush of the value labels text. |
| AxisTitleFontSize | Gets or sets the size of the value axis text. Default value is 6. |
| AxisTitleFontWeight | Gets or sets the FontWeight of the axis title text. |
| BackConnectionLinesVisual3D | Gets a MultiLineVisual3D that is used to show 3D lines that connect major ticks in the bottom and back rectangles. |
| BottomRectangleVisual3D | Gets a RectangleVisual3D that is used to show the bottom rectangle. |
| Camera | Gets or sets an Ab3d Camera that is used by this AxesBoxVisual3D. |
| CenterPosition | Gets or sets the center position of the 3D box used to create the lines |
| ConnectionLinesColor | Gets or sets the color of the connection lines that show major tick value on the bottom and back rectangles. Default value is Black. |
| ConnectionLinesThickness | Gets or sets the thickness of the connection lines that show major tick value on the bottom and back rectangles. Default value is 1. |
| FontFamily | Gets or sets the FontFamily of the text. |
| Is3DTextShown | Is3DTextShown specifies if the 3D axes are shows as AxisWith3DLabelsVisual3D (when true; by default) or as AxisWithOverlayLabelsVisual3D (when false). |
| IsAutomaticallySubscribedToCameraChanges | When true (by default) the Update method is automatically called on each change of the Camera. |
| IsWireBoxFullyClosed | IsWireBoxFullyClosed specifies if the the 3D lines are also drawn to the top front corner of the box to make the wire box fully closed. Default value is false. This draws only the side and back lines of the wire box and make the box appear opened. |
| IsXAxis1Visible | Gets or sets a Boolean that specified is XAxis1 is visible. This is a shortcut for XAxis1.IsVisible property. |
| IsXAxis2Visible | Gets or sets a Boolean that specified is XAxis2 is visible. This is a shortcut for XAxis2.IsVisible property. |
| IsYAxis1Visible | Gets or sets a Boolean that specified is YAxis1 is visible. This is a shortcut for YAxis1.IsVisible property. |
| IsYAxis2Visible | Gets or sets a Boolean that specified is YAxis2 is visible. This is a shortcut for YAxis2.IsVisible property. |
| IsZAxis1Visible | Gets or sets a Boolean that specified is ZAxis1 is visible. This is a shortcut for ZAxis1.IsVisible property. When this property is set by the user, then AxesBoxVisual3D will not change the ZAxis1 visibility even when AxisShowingStrategy is not None. |
| IsZAxis2Visible | Gets or sets a Boolean that specified is ZAxis2 is visible. This is a shortcut for ZAxis2.IsVisible property. When this property is set by the user, then AxesBoxVisual3D will not change the ZAxis1 visibility even when AxisShowingStrategy is not None. |
| MajorTicksLength | Gets or sets a double value that defines the length of major tick lines. Default value is 5. When set to 0, then major tick lines are not shown (but labels are still shown). |
| MinorTicksLength | Gets or sets a double value that defines the length of minor tick lines. Default value is 2.5. When set to 0, then minor tick lines are not shown. |
| OverlayCanvas | Gets or sets a Canvas that will show the axis numbers |
| ShowBackConnectionLines | Gets or sets a Boolean that specifies if connection lines that connect major ticks on X and Y axes are shown in the two back rectangle. Default value is false. To show the lines the ShowXAxisConnectionLines and ShowYAxisConnectionLines must be true. |
| ShowBottomConnectionLines | Gets or sets a Boolean that specifies if connection lines that connect major ticks on X and Y axes are shown in the bottom rectangle. Default value is true. To show the lines the ShowXAxisConnectionLines and ShowYAxisConnectionLines must be true. |
| ShowXAxisConnectionLines | Gets or sets a Boolean that specifies if vertical connection lines that show major ticks on X axis are shown in the background rectangles. Default value is true. To define where to show the connection lines set ShowBackConnectionLines or ShowBackConnectionLines to true. |
| ShowYAxisConnectionLines | Gets or sets a Boolean that specifies if vertical connection lines that show major ticks on Y axis are shown in the background rectangles. Default value is true. To define where to show the connection lines set ShowBackConnectionLines or ShowBackConnectionLines to true. |
| ShowZAxisConnectionLines | Gets or sets a Boolean that specifies if horizontal connection lines that show major ticks on Z axis are shown in the background rectangles. Default value is true. |
| Size | Gets or sets the size of the 3D box used to create the lines. Default value is (100, 100, 100). |
| TicksLineColor | Gets or sets the color of ticks lines. |
| TicksLineThickness | Gets or sets the thickness of the ticks lines in screen coordinates. Default value is 1. |
| TitleRenderBitmapSize | Gets or sets a Size that is used as the RenderBitmapSize in the TextBlockVisual3D object that is used to render the axes titles. When Ab3d.DXEngine assembly is present in the application, then the default value is set to (512, 64); otherwise the default value is Size.Empty that uses VisualBrush to render the text. This property sets the TitleRenderBitmapSize for all axes. To set Size for rendered value labels set the ValueLabelsRenderBitmapSize. |
| ValueDisplayCulture | Gets the culture that is used to format value labels. Default value is null (using current culture). |
| ValueDisplayFormatString | Gets or sets the string that defines the format string that is used to format the displayed values. When this string is empty, then values are not displayed. Default value is "#,##0". Culture that is used to format the value is defined by the ValueDisplayCulture property (InvariantCulture by default). |
| ValueLabelsBrush | Gets or sets the brush of the value labels text. |
| ValueLabelsFontSize | Gets or sets the size of the value labels text. Default value is 6. |
| ValueLabelsFontWeight | Gets or sets the FontWeight of the value labels text. |
| ValueLabelsPadding | Gets or sets a double value that how much are the value labels texts positioned away from the major tick markers. Default value is 3. |
| ValueLabelsRenderBitmapSize | Gets or sets a Size that is used as the RenderBitmapSize in all used TextBlockVisual3D objects that display value labels. When Ab3d.DXEngine assembly is present in the application, then the default value is set to (128, 64); otherwise the default value is Size.Empty that uses VisualBrush to render the text. This property sets the ValueLabelsRenderBitmapSize for all axes. To set Size for rendered axis title set the TitleRenderBitmapSize. |
| WireBoxLinesVisual3D | Gets a MultiLineVisual3D that is used to show major 3D lines for wire box. When IsWireBoxFullyClosed is false, then only the two back rectangles (between both Z axes) are rendered; when true all 3D lines are shown. |
| XAxis1 | Gets the AxisWith3DLabelsVisual3D or AxisWithOverlayLabelsVisual3D that is used to render first x axis. |
| XAxis1Title | Gets or sets the title for XAxis1. This is a shortcut for XAxis1.AxisTitle property. |
| XAxis2 | Gets the AxisWith3DLabelsVisual3D or AxisWithOverlayLabelsVisual3D that is used to render second x axis. |
| XAxis2Title | Gets or sets the title for XAxis2. This is a shortcut for XAxis2.AxisTitle property. |
| YAxis1 | Gets the AxisWith3DLabelsVisual3D or AxisWithOverlayLabelsVisual3D that is used to render first y axis. |
| YAxis1Title | Gets or sets the title for YAxis1. This is a shortcut for YAxis1.AxisTitle property. |
| YAxis2 | Gets the AxisWith3DLabelsVisual3D or AxisWithOverlayLabelsVisual3D that is used to render second y axis. |
| YAxis2Title | Gets or sets the title for YAxis2. This is a shortcut for YAxis2.AxisTitle property. |
| ZAxis1 | Gets the AxisWith3DLabelsVisual3D or AxisWithOverlayLabelsVisual3D that is used to render first z axis. |
| ZAxis1Title | Gets or sets the title for ZAxis1. This is a shortcut for ZAxis1.AxisTitle property. |
| ZAxis2 | Gets the AxisWith3DLabelsVisual3D or AxisWithOverlayLabelsVisual3D that is used to render second z axis. |
| ZAxis2Title | Gets or sets the title for ZAxis2. This is a shortcut for ZAxis2.AxisTitle property. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Dispose method frees the TextBlockVisual3D objects that are created by this AxesBoxVisual3D. |
| GetAllAxes | Returns an array of all AxisWithLabelsBase objects. |
| GetAllVisibleAxes | Returns an array of all AxisWithLabelsBase objects that have IsVisible set to true. |
  | OnAdjustFirstAndLastLabelPositionsPropertyChanged | OnAdjustFirstAndLastLabelPositionsPropertyChanged |
| OnAxesPropertyChanged | OnAxesPropertyChanged |
| OnCameraPropertyChanged | OnCameraPropertyChanged |
| OnConnectionLinesPropertyChanged | OnConnectionLinesPropertyChanged |
| OnOverlayCanvasPropertyChanged | OnOverlayCanvasPropertyChanged |
| OnPositionSizePropertyChanged | OnPositionSizePropertyChanged |
| SetAxisDataRange | SetAxisDataRange method sets the data range and ticks step for the specified axis. |
| Update | Update method updates the shown axes. |
| ValidatePositiveNumberPropertyValue | Returns true if value is valid double and bigger or equal to 0 |
Fields| Name | Description | |
|---|---|---|
 | AdjustFirstAndLastLabelPositionsProperty | AdjustFirstAndLastLabelPositionsProperty |
| AxisLineColorProperty | AxisLineColorProperty |
| AxisLineThicknessProperty | AxisLineThicknessProperty |
| AxisShowingStrategyProperty | AxisShowingStrategyProperty |
| AxisTitleBrushProperty | AxisTitleBrushProperty |
| AxisTitleFontSizeSizeProperty | FontSizeProperty |
| AxisTitleFontWeightProperty | AxisTitleFontWeightProperty |
| CameraProperty | CameraProperty |
| CenterPositionProperty | CenterPositionProperty |
| ConnectionLinesColorProperty | ConnectionLinesColorProperty |
| ConnectionLinesThicknessProperty | ConnectionLinesThicknessProperty |
| FontFamilyProperty | FontSizeProperty |
| Is3DTextShownProperty | Is3DTextShownProperty |
| IsWireBoxFullyClosedProperty | IsWireBoxFullyClosedProperty |
| MajorTicksLengthProperty | MajorTicksLengthProperty |
| MinorTicksLengthProperty | MinorTicksLengthProperty |
| OverlayCanvasProperty | OverlayCanvasProperty |
| ShowBackConnectionLinesProperty | ShowBackConnectionLinesProperty |
| ShowBottomConnectionLinesProperty | ShowBottomConnectionLinesProperty |
| ShowXAxisConnectionLinesProperty | ShowXAxisConnectionLinesProperty |
| ShowYAxisConnectionLinesProperty | ShowYAxisConnectionLinesProperty |
| ShowZAxisConnectionLinesProperty | ShowZAxisConnectionLinesProperty |
| SizeProperty | SizeProperty |
| TicksLineColorProperty | TicksLineColorProperty |
| TicksLineThicknessProperty | TicksLineThicknessProperty |
| ValueDisplayFormatStringProperty | ValueDisplayFormatStringProperty |
| ValueLabelsBrushProperty | ValueLabelsBrushProperty |
| ValueLabelsFontSizeProperty | FontSizeProperty |
| ValueLabelsFontWeightProperty | ValueLabelsFontWeightProperty |
| ValueLabelsPaddingProperty | ValueLabelsPaddingProperty |
Extension Methods| Name | Description | |
|---|---|---|
 | DumpHierarchy |
Display details about the hierarchy of Visual3D children to Debug console (for example to Visual Studio's Immediate window).
(Defined by Extensions) |
| ForEachGeometryModel3D |
Performs the specified action on each GeometryModel3D inside the rootModelVisual3D.
(Defined by Extensions) |
| ForEachVisual3D |
Performs the specified action on each ModelVisual3D inside the rootModelVisual3D.
(Defined by Extensions) |
| GetName |
Gets name of the Visual3D that was previously set by SetName extension method.
(Defined by Extensions) |
| SetName |
Sets Name property to Visual3D. Note that if name is not correct for WPF, it can be corrected (name must start with a letter or the underscore character (_), and must contain only letters, digits, or underscores).
In this case the SetName method will set the corrected name to the object and return false (in this case you can call GetName to get the corrected name). True is returned when the original name is set to the object.
(Defined by Extensions) |
See Also