Click or drag to resize
Ab4d.SharpEngine logo

OverlayPanelBase Methods

The OverlayPanelBase type exposes the following members.

Methods
 NameDescription
Public methodDispose Disposes the resources
Protected methodDispose(Boolean) Releases unmanaged and managed resources (when disposing is true). This method may be called only from the CheckAndDispose(Boolean) method and must not be called manually by the user.
(Overrides ComponentBaseDispose(Boolean))
Public methodGetPanelViewport Gets the position and size of this overlay panel in the parentSceneView.
Public methodGetPanelViewport(Boolean, Boolean) Gets the position and size of this overlay panel in the parentSceneView.
Protected methodGetSceneViewSize 
Protected methodNotifyOverlayPanelChanged Sets OverlayPanelChanged dirty flag in the ParentSceneView. This will request another frame rendering with another recording of command buffers.
Protected methodNotifyOverlayPanelUpdated Sets OverlayPanelUpdated dirty flag in the ParentSceneView. This will request another frame rendering without another recording of command buffers.
Protected methodNotifySizeOrPositionChanged Sets OverlayPanelChanged dirty flag in the ParentSceneView and also update the size in the next render pass.
Protected methodOnCameraChanged 
Protected methodOnCreateCamera OnCreateCamera method can be overridden in a derived class to create a custom camera. This method by default creates a TargetPositionCamera with Heading and Attitude set to 0 and Distance and ViewWidth to 100.
Protected methodOnCreateLights OnCreateLights method can be overridden to provide custom lights in the scene. If the method is called, then a 30% ambient light is set.
Protected methodOnCreateScene OnCreateScene method can be overriden in the derived class to create the 3D objects that are rendered by this overlay panel. To use async method the derived class can also override OnCreateSceneAsync(Scene) method.
Protected methodOnCreateSceneAsync OnCreateSceneAsync method can be overriden in the derived class to create the 3D objects that are rendered by this overlay panel. To use async method the derived class can also override OnCreateSceneAsync(Scene) method.
Protected methodOnInitializeDeviceResources Initializes resources with the specified GpuDevice. This method can be overriden and is called from InitializeDeviceResources(VulkanDevice) method.
Protected methodSetAlignment Sets the Alignment value.
Protected methodSetBackgroundColor Sets the BackgroundColor value.
Protected methodSetHeight Sets the Height value.
Protected methodSetPosition Sets the Position value.
Protected methodSetWidth Sets the Width value.
Protected methodSubscribeCameraChanged 
Protected methodUnsubscribeCameraChanged 
Public methodUpdate 
Public methodUpdate(SceneDirtyFlags, SceneViewDirtyFlags) Updates common panel state. Derived classes can override this method to update scene objects or the overlay camera.
Top
See Also