Provides typed access to NDPE effect properties on a DesignObject. More...

Inheritance diagram for PropertyInterface< NDPE >:

Collaboration diagram for PropertyInterface< NDPE >:

Static Public Member Functions
static TableColumn *	column (const DesignInfo *object, NDPE property)
	Retrieves the TableColumn pointer for a given property on the specified design object.
template<NDPE t_property>
static decltype(auto)	Get (const DesignInfo *object)
	Gets an effect property value using compile-time property index, with the type deduced from PropertySpec.
template<NDPE t_property, class t_value_type>
static decltype(auto)	Get (const DesignInfo *object)
	Gets an effect property value using compile-time property index and explicit value type.
template<class t_value_type>
static decltype(auto)	Get (const DesignInfo *object, NDPE property)
	Gets an effect property value from the given object using a runtime property index.
static uint04	index (const DesignInfo *object, NDPE property)
	Retrieves the row index for a given property on the specified design object.
static bool	IsSame (const DesignInfo *object, NDPE property, const StringView &value)
	Checks whether an effect property matches a given string value.
template<NDPE t_property, class t_value_type>
static void	Set (DesignInfo *object, const t_value_type &value)
	Sets an effect property value on the given object using a compile-time property index.
template<class t_value_type>
static void	Set (DesignInfo *object, NDPE property, const t_value_type &value)
	Sets an effect property value on the given object using a runtime property index.

Detailed Description

Provides typed access to NDPE effect properties on a DesignObject.

Implements static Set, Get, and IsSame operations that read from and write to the effect property columns of a DesignObjectBase.

Definition at line 78 of file Effect.h.

Member Function Documentation

◆ column()

TableColumn * PropertyInterface< NDPE >::column	(	const DesignInfo *	object,
		NDPE	property )

inlinestatic

Retrieves the TableColumn pointer for a given property on the specified design object.

Parameters

[in]	object	The design object to query.
[in]	property	The property enum value identifying the column.

Returns: Pointer to the TableColumn storing the property data.

Definition at line 133 of file DesignProperties.h.

◆ Get() [1/3]

template<NDPE t_property>

decltype(auto) PropertyInterface< NDPE >::Get ( const DesignInfo * object )

inlinestatic

Gets an effect property value using compile-time property index, with the type deduced from PropertySpec.

Parameters

[in] object The design info whose effect property is being read.

Returns: The property value in its PropertySpec-defined type.

Definition at line 130 of file Effect.h.

◆ Get() [2/3]

template<NDPE t_property, class t_value_type>

decltype(auto) PropertyInterface< NDPE >::Get ( const DesignInfo * object )

inlinestatic

Gets an effect property value using compile-time property index and explicit value type.

Parameters

[in] object The design info whose effect property is being read.

Returns: The property value cast to t_value_type.

Definition at line 119 of file Effect.h.

◆ Get() [3/3]

template<class t_value_type>

decltype(auto) PropertyInterface< NDPE >::Get	(	const DesignInfo *	object,
		NDPE	property )

inlinestatic

Gets an effect property value from the given object using a runtime property index.

Parameters

[in]	object	The design info whose effect property is being read.
[in]	property	The NDPE property to retrieve.

Returns: The property value cast to t_value_type.

Definition at line 109 of file Effect.h.

◆ index()

uint04 PropertyInterface< NDPE >::index	(	const DesignInfo *	object,
		NDPE	property )

inlinestatic

Retrieves the row index for a given property on the specified design object.

Parameters

[in]	object	The design object to query.
[in]	property	The property enum value.

Returns: The row index into the property column.

Definition at line 144 of file DesignProperties.h.

◆ IsSame()

bool PropertyInterface< NDPE >::IsSame	(	const DesignInfo *	object,
		NDPE	property,
		const StringView &	value )

inlinestatic

Checks whether an effect property matches a given string value.

Parameters

[in]	object	The design info to check.
[in]	property	The NDPE property to compare.
[in]	value	The string value to compare against.

Returns: True if the stored property value matches the given string.

Definition at line 141 of file Effect.h.

References DesignInfo::m_design_index.

◆ Set() [1/2]

template<NDPE t_property, class t_value_type>

void PropertyInterface< NDPE >::Set	(	DesignInfo *	object,
		const t_value_type &	value )

inlinestatic

Sets an effect property value on the given object using a compile-time property index.

Parameters

[in]	object	The design info whose effect property is being set.
[in]	value	The value to assign.

Definition at line 98 of file Effect.h.

References DesignInfo::m_design_index.

◆ Set() [2/2]

template<class t_value_type>

void PropertyInterface< NDPE >::Set	(	DesignInfo *	object,
		NDPE	property,
		const t_value_type &	value )

inlinestatic

Sets an effect property value on the given object using a runtime property index.

Parameters

[in]	object	The design info whose effect property is being set.
[in]	property	The NDPE property to set.
[in]	value	The value to assign.

Definition at line 88 of file Effect.h.

References DesignInfo::m_design_index.

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

Design/Headers/Effect.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ column()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ index()

◆ IsSame()

◆ Set() [1/2]

◆ Set() [2/2]