Loading...
Searching...
No Matches
OFT.Rendering.Settings.RenderSettingsBase< TRender > Class Template Referenceabstract

Base class for rendering settings. More...

Inheritance diagram for OFT.Rendering.Settings.RenderSettingsBase< TRender >:
[legend]
Collaboration diagram for OFT.Rendering.Settings.RenderSettingsBase< TRender >:
[legend]

Public Member Functions

abstract object Clone ()
 

Protected Member Functions

 RenderSettingsBase ()
 Initializes a new instance of the RenderSettingsBase<TRender> class.
 
abstract TRender CreateDefaultRenderObject ()
 Creates the default render object.
 
abstract TRender GenerateRenderObject ()
 Generates the render object based on the current settings.
 
virtual void RaisePropertyChanged ([CallerMemberName] string? propertyName=null)
 Raises the PropertyChanged event for a specific property.
 
void SetProperty< TProperty > (ref TProperty store, TProperty value, [CallerMemberName] string? propertyName=null, Action? onChanged=null)
 Sets a property value and raises the PropertyChanged event if the value changes.
 

Properties

TRender RenderObject [get]
 Gets the render object associated with the settings.
 

Events

PropertyChangedEventHandler? PropertyChanged
 

Detailed Description

Base class for rendering settings.

Template Parameters
TRenderThe type of the render object.
Type Constraints
TRender :class 

Constructor & Destructor Documentation

◆ RenderSettingsBase()

Initializes a new instance of the RenderSettingsBase<TRender> class.

Member Function Documentation

◆ Clone()

◆ CreateDefaultRenderObject()

abstract TRender OFT.Rendering.Settings.RenderSettingsBase< TRender >.CreateDefaultRenderObject ( )
protectedpure virtual

Creates the default render object.

Returns
The default render object.

Implemented in OFT.Rendering.Settings.BrushSettings, OFT.Rendering.Settings.FontSetting, and OFT.Rendering.Settings.PenSettings.

◆ GenerateRenderObject()

abstract TRender OFT.Rendering.Settings.RenderSettingsBase< TRender >.GenerateRenderObject ( )
protectedpure virtual

Generates the render object based on the current settings.

Returns
The generated render object.

Implemented in OFT.Rendering.Settings.BrushSettings, OFT.Rendering.Settings.BrushSettings, OFT.Rendering.Settings.FontSetting, OFT.Rendering.Settings.PenSettings, and OFT.Rendering.Settings.PenSettings.

◆ RaisePropertyChanged()

virtual void OFT.Rendering.Settings.RenderSettingsBase< TRender >.RaisePropertyChanged ( [CallerMemberName] string?  propertyName = null)
protectedvirtual

Raises the PropertyChanged event for a specific property.

Parameters
propertyNameThe name of the property that changed.

◆ SetProperty< TProperty >()

void OFT.Rendering.Settings.RenderSettingsBase< TRender >.SetProperty< TProperty > ( ref TProperty  store,
TProperty  value,
[CallerMemberName] string?  propertyName = null,
Action?  onChanged = null 
)
protected

Sets a property value and raises the PropertyChanged event if the value changes.

Template Parameters
TPropertyThe type of the property.
Parameters
storeReference to the storage field for the property.
valueThe new value of the property.
propertyNameThe name of the property.
onChangedOptional action to be executed when the property value changes.

Property Documentation

◆ RenderObject

TRender OFT.Rendering.Settings.RenderSettingsBase< TRender >.RenderObject
get

Gets the render object associated with the settings.

Event Documentation

◆ PropertyChanged

PropertyChangedEventHandler? OFT.Rendering.Settings.RenderSettingsBase< TRender >.PropertyChanged


The documentation for this class was generated from the following file: