#include <STY_Subject.h>

Inheritance diagram for STY_Subject:

Public Member Functions
virtual	~STY_Subject ()

virtual STY_TargetMatchStatus	matchesStyleTarget (const STY_TargetHandle &target) const =0
	Returns the information wheter the subject matches the given target. More...

virtual STY_BindingDataSourceHandle	getOverrideBindingDataSource (const UT_StringHolder &data_name) const

virtual STY_StyleSheetHandle	getPreFilterStyleSheet () const

virtual STY_StyleSheetHandle	getPostFilterStyleSheet () const

virtual UT_StringHolder	getSourceLocation () const

Public Member Functions inherited from UT_IntrusiveRefCounter< STY_Subject >
SYS_FORCE_INLINE	UT_IntrusiveRefCounter () noexcept
	Default constructor: Sets counter to 0. More...

SYS_FORCE_INLINE	UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &) noexcept
	Copy constructor: Sets counter to 0. More...

UT_IntrusiveRefCounter &	operator= (const UT_IntrusiveRefCounter &) noexcept
	Assignment operator: Does not modify counter. More...

SYS_FORCE_INLINE uint32	use_count () const noexcept
	Return current counter. More...

SYS_FORCE_INLINE bool	conditionalAddRef () noexcept

Protected Member Functions
STY_TargetMatchStatus	matchesPathHelper (const UT_StringRef &path, const STY_TargetHandle &target, char separator) const
	Helper for handling path requirement. More...

Protected Member Functions inherited from UT_IntrusiveRefCounter< STY_Subject >
SYS_FORCE_INLINE	~UT_IntrusiveRefCounter ()
	Destructor: Only derived classes can destruct this. More...

Detailed Description

Describes the entity subjected to stylilng, ie, entity whose properties can be overriden by style sheets (eg, a specific primitive in the whole scene, whose material diffuse color is being overriden from blue to red). Subjects matching a given target may be asked to provide pre binding data associated with the target. Also, subject may optionally provide additional style sheet, which contains overrides that are intended to itself (self-targeted entries) or that are intended for subject's children (non self-target entries), if subjects are structured hierarchically (eg, in the case of packed primitives).

Definition at line 30 of file STY_Subject.h.

Constructor & Destructor Documentation

virtual STY_Subject::~STY_Subject ( )

inlinevirtual

Definition at line 34 of file STY_Subject.h.

Member Function Documentation

virtual STY_BindingDataSourceHandle STY_Subject::getOverrideBindingDataSource ( const UT_StringHolder & data_name ) const

virtual

Returns a source object that can provide data for the given data name. Eg, style subject representing a primitive can provide primitive attribute data.

Reimplemented in GSTY_SubjectPoint, GSTY_SubjectPrim, STY_SubjectSelf, and GU_AgentSubjectShape.

virtual STY_StyleSheetHandle STY_Subject::getPostFilterStyleSheet ( ) const

virtual

Returns the style sheet that should be applied to this subject and its children. This style sheet is applied after this subject is used to filter out non-matching styles. The children of this subject are the top level targets for these styles. Returns an empty string, if no style sheet is provided.

Reimplemented in GSTY_SubjectPoint, GSTY_SubjectPrim, GSTY_SubjectGeoObject, and STY_SubjectSelf.

virtual STY_StyleSheetHandle STY_Subject::getPreFilterStyleSheet ( ) const

virtual

Returns the style sheet that should be applied to this subject. This style sheet is applied before this subject is used to filter out non-matching styles. This subject is the top level target for these styles. Returns an empty string, if no style sheet is provided.

Reimplemented in GSTY_SubjectPoint, GSTY_SubjectPrim, and STY_SubjectSelf.

virtual UT_StringHolder STY_Subject::getSourceLocation ( ) const

virtual

Returns the location where the above subject-specific style sheet comes from. For example the name of the object, prim number, etc. Returns a default value of "Unknown Subject Source".

Reimplemented in GSTY_SubjectPoint, GSTY_SubjectPrim, and GSTY_SubjectGeoObject.

STY_TargetMatchStatus STY_Subject::matchesPathHelper	(	const UT_StringRef &	path,
		const STY_TargetHandle &	target,
		char	separator
	)		const

protected

Helper for handling path requirement.

virtual STY_TargetMatchStatus STY_Subject::matchesStyleTarget ( const STY_TargetHandle & target ) const

pure virtual

Returns the information wheter the subject matches the given target.

Implemented in GSTY_SubjectPoint, GSTY_SubjectPrim, STY_SubjectSelf, GSTY_SubjectGeoObject, and GU_AgentSubjectShape.

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

STY/STY_Subject.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation