Rumba C++ SDK
maquina::PartialInvalidation Class Referenceabstract

A plug's partial invalidation descriptor. More...

#include <PartialInvalidation.h>

Public Member Functions

virtual ~PartialInvalidation ()
 
virtual Ptr< const PartialInvalidationmake_union (const Ptr< const PartialInvalidation > &self, const Ptr< const PartialInvalidation > &o) const =0
 Performs the union of self and o. If o is included in self, returns self. If self is included in o, returns o. More...
 

Static Public Attributes

static MAQUINA_EXPORT const Ptr< const PartialInvalidationempty
 Special value if the invalidation is empty, i-e, the destination plug must not be touched. More...
 

Detailed Description

A plug's partial invalidation descriptor.

When a plug is touched (invalidated) with no PartialInvalidation provided, it is completly invalidated. In order to optimize some processes, one can precise when the plug is modified that the plug is partially invalidated using objects of a class derived from PartialInvalidation.

For instance, such descriptors can be used to invalidate only a precise path in a Scene value but not all the Scene's content.

Constructor & Destructor Documentation

◆ ~PartialInvalidation()

virtual maquina::PartialInvalidation::~PartialInvalidation ( )
inlinevirtual

Member Function Documentation

◆ make_union()

virtual Ptr<const PartialInvalidation> maquina::PartialInvalidation::make_union ( const Ptr< const PartialInvalidation > &  self,
const Ptr< const PartialInvalidation > &  o 
) const
pure virtual

Performs the union of self and o. If o is included in self, returns self. If self is included in o, returns o.

Parameters
selfThe Ptr of this. Ptr.get() == this.
oThe second PartialInvalidation, can be nullptr.
Returns
The union of this and o. The method can return self or o if necessary.

Member Data Documentation

◆ empty

MAQUINA_EXPORT const Ptr<const PartialInvalidation> maquina::PartialInvalidation::empty
static

Special value if the invalidation is empty, i-e, the destination plug must not be touched.


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