Click or drag to resize
AB4D logo

BaseAxisWithLabelsVisual3D Methods

The BaseAxisWithLabelsVisual3D type exposes the following members.

Methods
 NameDescription
Protected methodCloneInt Returns a new AxisWithLabelsBase that is a clone of this AxisWithLabelsBase.
Public methodGetMajorTickValues Returns an array of double value that represents the major tick values. By default major tick values are calculated based on MinimumValue, MaximumValue and MajorTicksStep properties.
Public methodGetMinorTickValues Returns an array of double value that represents the minor tick values. By default minor tick values are calculated based on MinimumValue, MaximumValue and MinorTicksStep properties.
Public methodGetRelativeValue GetRelativeValue returns a relative value in range from 0 to 1 from the specified absoluteValue (where the value lies between the AxisStartPosition and AxisEndPosition). Value 0 is returned when absoluteValue is set to MinimumValue. Value 1 is returned when absoluteValue is set to the value returned by the GetUsedMaximumValue method. Returned value is negative when absoluteValue is smaller then MinimumValue and bigger then 1 when the absoluteValue is bigger then used maximum value.
Public methodGetUsedMaximumValue Returns the used maximum value. This value can be different from MaximumValue when SnapMaximumValueToMajorTicks is set to true.
Public methodGetValueLabels Returns an array of strings that represents the value labels.
Protected methodGetValuesRange GetValuesRange returns the difference between used maximum value and used minimum value. Note that used maximum value can be different from MaximumValue when SnapMaximumValueToMajorTicks is set to true
Protected methodOnAxisTitleSettingsChanged(DependencyPropertyChangedEventArgs) OnAxisTitleSettingsChanged method must be implemented by a derived class. The method is called when the font settings for axis title is changed.
Protected methodStatic memberOnAxisTitleSettingsChanged(DependencyObject, DependencyPropertyChangedEventArgs) OnAxisTitleSettingsChanged
Protected methodOnCameraChanged OnCameraChanged method is called when the camera is changed. The method can be overriden in a derived class.
Protected methodStatic memberOnCameraPropertyChanged OnCameraPropertyChanged
Protected methodStatic memberOnFontFamilyPropertyChanged OnFontFamilyPropertyChanged
Protected methodOnIsVisibleChanged OnIsVisibleChanged is called when the value of IsActuallyVisible property is changed.
(Overrides ContentVisual3DOnIsVisibleChanged(Boolean))
Protected methodStatic memberOnLinePropertyChanged OnLinePropertyChanged
Protected methodStatic memberOnTicksMultiLinePropertyChanged OnTicksMultiLinePropertyChanged
Protected methodOnTicksPositionsChanged OnTicksPositionsChanged method must be implemented by a derived class. The method is called when the tick positions are changed.
Protected methodStatic memberOnTicksSettingsChanged OnTicksSettingsChanged
Protected methodOnUpdate OnUpdate method must be implemented by a derived class. The method is called when the Update method is called and should update the axis.
Protected methodOnValueLabelsFontSettingsChanged(DependencyPropertyChangedEventArgs) OnValueLabelsFontSettingsChanged method must be implemented by a derived class. The method is called when the font settings for value labels is changed.
Protected methodStatic memberOnValueLabelsFontSettingsChanged(DependencyObject, DependencyPropertyChangedEventArgs) OnValueLabelsFontSettingsChanged
Protected methodOnViewport3DSizeChanged OnViewport3DSizeChanged is called when the size of Viewport3D is changed. The method can be overriden in a derived class.
Public methodSetCustomMajorTickValues SetCustomMajorTickValues method sets custom double values that represents custom major tick values. The tick values should be between MinimumValue and MaximumValue (values outside of this range will not be shown). The values define the text for the shown labels (when custom labels are not used) and also define the positions of the major tick lines and value labels - if the value is in the middle between MinimumValue and MaximumValue, the tick and label will be also shown in the middle between AxisStartPosition and AxisEndPosition. When customMajorTickValues is null, then major thick lines and value labels will not be shown.
Public methodSetCustomMinorTickValues SetCustomMinorTickValues method sets custom double values that represents custom minor tick values. The tick values should be between MinimumValue and MaximumValue (values outside of this range will not be shown). The values define the positions of the minor tick lines. When customMinorTickValues is null, then minor thick lines will not be shown.
Public methodSetCustomValueColors SetCustomValueColors method sets custom colors for value labels. The number of elements in the customValueLabels array should be the same as number of displayed major ticks (to get this number call GetValueLabels method). To stop using custom value color, call this method with null. To set custom value colors, call SetCustomValueColors(Color) method.
Public methodSetCustomValueLabels SetCustomValueLabels method sets custom texts that will be used as value labels. One value label is displayed for one major tick. The number of elements in the customValueLabels array should be the same as number of displayed major ticks (to get this number call GetValueLabels method). To skip a value label set the array element to null or empty string. To set custom value colors, call SetCustomValueColors(Color) method.
Public methodUpdate Update method is called to update this axis.
Protected methodUpdateContentIfNotInitializing Recreates the models if the Visual3D is visible (IsVisible is true) and it is not initializing (between BeginInit and EndInit)
(Overrides BaseVisual3DUpdateContentIfNotInitializing)
Protected methodUpdateTicksMultiLinePositions UpdateTicksMultiLinePositions method sets various 3D positions (majorTickPositions, minorTickPositions, valueLabelPositions) that represent positions of ticks and value labels in 3D space. The values are calculated based on majorTickValues, minorTickValues and valueLabels lists. The method is virtual and can be overriden to provide custom positioning of ticks and value labels.
Protected methodUpdateTickValues UpdateTickValues method sets values of each major and minor tick and writes them into majorTickValues, minorTickValues lists. The method also for each major tick sets the value label text and set that to valueLabels list. The method is virtual and can be overriden to provide custom calculation of ticks and value label texts.
Protected methodStatic memberValidatePositiveNumberPropertyValue Returns true if value is valid double and bigger or equal to 0
Protected methodStatic memberValidateValidDoublePropertyValue Returns true if value is valid double
Top
Extension Methods
 NameDescription
Public Extension MethodDumpHierarchy Display details about the hierarchy of Visual3D children to Debug console (for example to Visual Studio's Immediate window).
(Defined by Extensions)
Public Extension MethodForEachGeometryModel3D Performs the specified action on each GeometryModel3D inside the rootModelVisual3D.
(Defined by Extensions)
Public Extension MethodForEachVisual3D Performs the specified action on each ModelVisual3D inside the rootModelVisual3D.
(Defined by Extensions)
Public Extension MethodGetName Gets name of the Visual3D that was previously set by SetName extension method.
(Defined by Extensions)
Public Extension MethodSetName 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
See Also