BaseVisual3D Class


BaseVisual3D Class

BaseVisual3D is a base class for all Visual3D classes in Ab3d.PowerToys. It adds IsVisible property and support for ISupportInitialize interface.

Inheritance Hierarchy

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

Syntax

Copy

public abstract class BaseVisual3D : ModelVisual3D, 
	ISupportInitialize

The BaseVisual3D type exposes the following members.

Constructors

	Name	Description
	BaseVisual3D	Constructor
	BaseVisual3D(String)	Constructor

Top

Properties

	Name	Description
	IsActuallyVisible	Gets a Boolean that specifies if this object is actually visible taking parent's visibility into account - this.IsVisible is true and also the parent is visible. Note: when this Visual3D or any parent Visual3D is connected to a ModelVisual3D, then the value of IsActuallyVisible may not be correct (in case the parent ModelVisual3D is not connected to Viewport3D, then this IsActuallyVisible may still be true). When parents of Visual3D are only ContentVisual3D objects and Viewport3D, then the value of IsActuallyVisible is correct.
	IsVisible	Gets or sets a Boolean that specify if the object is visible. Note that if parent is not visible, then this object is also not visible even if IsVisible is true. See IsActuallyVisible to get the value if this object is actually visible.
	Parent	Gets the DependencyObject that is parent of this BaseVisual3D. When this BaseVisual3D is added to a Viewport3D then Parent is set to Viewport3DVisual, otherwise it is set to a parent Visual3D or to null (when no parent is assigned).
	Tag	Gets or sets any object as a Tag to this object (using FrameworkElement.TagProperty).

Top

Methods

	Name	Description
	BeginInit	Signals the line 3D that initialization is starting.
	CreateModel	Creates this Model3D
	EndInit	Signals the line 3D that initialization is complete.
	GetContent	GetContent return the Model3D from the Content property (when this Visual3D is visible) or from the protected savedHiddenContent field (when this Visual3D is hidden, then the Model3D from the Content is set to savedHiddenContent field so that Content can be set to null to hide this Visual3D).
	OnIsVisibleChanged	OnIsVisibleChanged is called when the value of IsActuallyVisible property is changed.
	OnParentChanged	OnParentChanged
	OnPropertyChanged	OnPropertyChanged method calls UpdateContentIfNotInitializing that recreates the model is visible (IsVisible is true) and if not initializing (between BeginInit and EndInit).
	OnVisualParentChanged	OnVisualParentChanged (Overrides Visual3DOnVisualParentChanged(DependencyObject))
	SetContent	SetContent method sets the specified model3D to the Content property (when this Visual3D is visible), or to the savedHiddenContent field (when this Visual3D is hidden, then the Model3D from the Content is set to savedHiddenContent field so that Content can be set to null to hide this Visual3D).
	UpdateContentIfNotInitializing	Recreates the models if the Visual3D is visible (IsVisible is true) and it is not initializing (between BeginInit and EndInit)
	ValidateDoublePropertyValue	Returns true if value is valid double
	ValidatePositiveDoublePropertyValue	Returns true if value is valid double and is positive
	ValidatePositiveIntPropertyValue	Returns true if value is positive integer
	ValidateSize3DOneZeroAllowedPropertyValue	Returns true if the value is a valid Size3D object used for Box3D (one size component is allowed to be zero)
	ValidateSize3DPropertyValue	Returns true if the value is a valid Size3D object
	ValidateSizePropertyValue	Returns true if the value is a valid Size object

Top

Events

	Name	Description
	IsVisibleChanged	Notify that the value of IsActuallyVisible property is changed. When true is returned from event handler, this prevents handling the change in this class. This is used when rendering in DXEngine. There handling IsVisible changes is optimized and does not require to remove the content of this Visual3D from visual 3D tree.
	ParentChanged	ParentChanged event is triggered when the Parent of this BaseVisual3D is changed.

Top

Fields

	Name	Description
	isInitializing	if true the Visual3D is initializing (between BeginInit and EndInit)
	IsVisibleProperty	IsVisibleProperty
	savedHiddenContent	savedHiddenContent stores the content of this model when it is hidden so that Content can be null. When this Visual3D is visible again, the Model3D that is set to this savedHiddenContent is set back to the Content property. To get or set Content or savedHiddenContent use GetContent and SetContent(Model3D) methods.

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

Inheritance Hierarchy