AxisWithOverlayLabelsVisual3D Class


AxisWithOverlayLabelsVisual3D Class

AxisWithOverlayLabelsVisual3D shows one 3D axis with axis title and value labels (and tick lines - when IsRenderingTickLinesOnOverlay is true) shown as 2D Text in the OverlayCanvas (a Canvas that should be defied on top of Viewport3D). The main axis line (and tick lines - when IsRenderingTickLinesOnOverlay is false) are shown as 3D lines.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.Media.Media3DVisual3D
        System.Windows.Media.Media3DModelVisual3D
          Ab3d.VisualsBaseVisual3D
            Ab3d.VisualsContentVisual3D
              Ab3d.VisualsBaseAxisWithLabelsVisual3D
                Ab3d.VisualsAxisWithOverlayLabelsVisual3D

Namespace: Ab3d.Visuals
Assembly: Ab3d.PowerToys (in Ab3d.PowerToys.dll) Version: 11.2.9104.2045

Syntax

Copy

public class AxisWithOverlayLabelsVisual3D : BaseAxisWithLabelsVisual3D

The AxisWithOverlayLabelsVisual3D type exposes the following members.

Constructors

	Name	Description
	AxisWithOverlayLabelsVisual3D	Constructor
	AxisWithOverlayLabelsVisual3D(String)	Constructor

Top

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 LabelXAdjustmentFactor (0.25 by default) or LabelYAdjustmentFactor (0.5 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 LabelXAdjustmentFactor (0.25 by default) or LabelYAdjustmentFactor (0.5 by default). Default value is false.
	CustomizeValueLabelAction	When set, this action is called so the user can customize the TextBlock before it is added to the axis. The first parameter is the index of the value label, the second is the TextBlock.
	IsRenderingTickLinesOnOverlay	Gets or sets a Boolean that specifies if tick lines are rendered to Overlay as 2D lines. When true (by default) then thick lines are rendered as 2D lines on the Overlay Canvas. When false the tick lines are rendered as 3D lines.
	OverlayCanvas	Gets or sets a Canvas that will show the axis numbers

Top

Methods

	Name	Description
	ClearOverlayElements	ClearOverlayElements removes all elements (TextBlocks) that were added to the OverlayCanvas.
	Clone	Returns a new BaseAxisWithOverlayLabels that is a clone of this BaseAxisWithOverlayLabels.
	GetTitleTextBlockPosition	GetTitleTextBlockPosition returns the 2D position of the title TextBlock.
	OnAxisTitleSettingsChanged	OnAxisTitleSettingsChanged method must be implemented by a derived class. The method is called when the font settings for axis title is changed. (Overrides BaseAxisWithLabelsVisual3DOnAxisTitleSettingsChanged(DependencyPropertyChangedEventArgs))
	OnCameraChanged	OnCameraChanged method is called when the camera is changed. The method can be overriden in a derived class. (Overrides BaseAxisWithLabelsVisual3DOnCameraChanged)
	OnIsRenderingTickLinesOnOverlayPropertyChanged	OnIsRenderingTickLinesOnOverlayPropertyChanged
	OnIsVisibleChanged	OnIsVisibleChanged is called when the value of IsActuallyVisible property is changed. (Overrides BaseAxisWithLabelsVisual3DOnIsVisibleChanged(Boolean))
	OnTicksPositionsChanged	OnTicksPositionsChanged method must be implemented by a derived class. The method is called when the tick positions are changed. (Overrides BaseAxisWithLabelsVisual3DOnTicksPositionsChanged)
	OnUpdate	OnUpdate method must be implemented by a derived class. The method is called when the Update method is called and should update the axis. (Overrides BaseAxisWithLabelsVisual3DOnUpdate)
	OnValueLabelsFontSettingsChanged	OnValueLabelsFontSettingsChanged method must be implemented by a derived class. The method is called when the font settings for value labels is changed. (Overrides BaseAxisWithLabelsVisual3DOnValueLabelsFontSettingsChanged(DependencyPropertyChangedEventArgs))
	OnViewport3DSizeChanged	OnViewport3DSizeChanged is called when the size of Viewport3D is changed. The method can be overriden in a derived class. (Overrides BaseAxisWithLabelsVisual3DOnViewport3DSizeChanged)
	UpdateLabelTextBlocksPosition	UpdateLabelTextBlocksPosition is used to position the TextBloc objects in allDataTextBlocks list.

Top

Fields

	Name	Description
	AdjustFirstLabelPositionProperty	AdjustFirstLabelPositionProperty
	AdjustLastLabelPositionProperty	AdjustLastLabelPositionProperty
	allDataTextBlocks	List of TextBlock objects used to render value labels.
	IsRenderingTickLinesOnOverlayProperty	IsRenderingTicksOnOverlayProperty
	LabelXAdjustmentFactor	Gets or sets a double that specifies a factor that is multiplied by FontSize and used to adjust the X position of the first or last label when AdjustFirstLabelPosition or are used.
	LabelYAdjustmentFactor	Gets or sets a double that specifies a factor that is multiplied by FontSize and used to adjust the Y position of the first or last label when AdjustFirstLabelPosition or are used.
	majorTickOverlayLines	List of 2D lines (WPF's Shapes.Line objects) used to render major ticks.
	minorTickOverlayLines	List of 2D lines (WPF's Shapes.Line objects) used to render minor ticks.
	OverlayCanvasProperty	OverlayCanvasProperty
	titleTextBlock	TextBlock used to render axis title.

Top

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)

Top

Reference

Ab3d.Visuals Namespace