REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
AttributeLockKit () | |
AttributeLockKit (AttributeLockKit const &in_kit) | |
AttributeLockKit (AttributeLockKit &&in_that) | |
bool | Empty () const |
bool | Equals (AttributeLockKit const &in_kit) const |
Type | ObjectType () const |
bool | operator!= (AttributeLockKit const &in_kit) const |
AttributeLockKit & | operator= (AttributeLockKit &&in_that) |
AttributeLockKit & | operator= (AttributeLockKit const &in_kit) |
bool | operator== (AttributeLockKit const &in_kit) const |
void | Set (AttributeLockKit const &in_kit) |
AttributeLockKit & | SetLock (AttributeLock::Type in_type, bool in_state=true) |
AttributeLockKit & | SetLock (AttributeLockTypeArray const &in_types, BoolArray const &in_states) |
AttributeLockKit & | SetSubsegmentLockOverride (AttributeLock::Type in_type, bool in_state=true) |
AttributeLockKit & | SetSubsegmentLockOverride (AttributeLockTypeArray const &in_types, BoolArray const &in_states) |
void | Show (AttributeLockKit &out_kit) const |
bool | ShowLock (AttributeLock::Type in_type, bool &out_state) const |
bool | ShowLock (AttributeLockTypeArray &out_types, BoolArray &out_states) const |
bool | ShowSubsegmentLockOverride (AttributeLock::Type in_type, bool &out_state) const |
bool | ShowSubsegmentLockOverride (AttributeLockTypeArray &out_types, BoolArray &out_states) const |
AttributeLockKit & | UnsetEverything () |
AttributeLockKit & | UnsetLock (AttributeLock::Type in_type=AttributeLock::Type::Everything) |
AttributeLockKit & | UnsetLock (AttributeLockTypeArray const &in_types) |
AttributeLockKit & | UnsetSubsegmentLockOverride (AttributeLock::Type in_type=AttributeLock::Type::Everything) |
AttributeLockKit & | UnsetSubsegmentLockOverride (AttributeLockTypeArray const &in_types) |
virtual | ~AttributeLockKit () |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Static Public Member Functions | |
static AttributeLockKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The AttributeLockKit class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. This control is used to set and unset attribute locks at the segment level. Calling AttributeLockKit::GetDefault() will return a kit with values found in this table.
AttributeLockKit::AttributeLockKit | ( | ) |
Initializes an empty kit.
AttributeLockKit::AttributeLockKit | ( | AttributeLockKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
AttributeLockKit::AttributeLockKit | ( | AttributeLockKit && | in_that | ) |
The move constructor creates a AttributeLockKit by transferring the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a AttributeLockKit to take the impl from. |
|
virtual |
Destroy this kit.
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from Object.
bool AttributeLockKit::Equals | ( | AttributeLockKit const & | in_kit | ) | const |
Check if the source AttributeLockKit is equivalent to this object.
in_kit | The source AttributeLockKit to compare to this object. |
|
static |
Creates an AttributeLockKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool AttributeLockKit::operator!= | ( | AttributeLockKit const & | in_kit | ) | const |
Check if the source AttributeLockKit is not equivalent to this object.
in_kit | The source AttributeLockKit to compare to this object. |
AttributeLockKit& AttributeLockKit::operator= | ( | AttributeLockKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy.
in_that | An rvalue reference to a AttributeLockKit to take the impl from. |
AttributeLockKit& AttributeLockKit::operator= | ( | AttributeLockKit const & | in_kit | ) |
Copies the source AttributeLockKit into this object.
in_kit | The source AttributeLockKit to copy. |
bool AttributeLockKit::operator== | ( | AttributeLockKit const & | in_kit | ) | const |
Check if the source AttributeLockKit is equivalent to this object.
in_kit | The source AttributeLockKit to compare to this object. |
void AttributeLockKit::Set | ( | AttributeLockKit const & | in_kit | ) |
Copies the source AttributeLockKit into this object.
in_kit | The source object to copy. |
AttributeLockKit& AttributeLockKit::SetLock | ( | AttributeLock::Type | in_type, |
bool | in_state = true |
||
) |
Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.
in_type | The type of attribute to lock or unlock. |
in_state | Whether the attribute should be locked. |
AttributeLockKit& AttributeLockKit::SetLock | ( | AttributeLockTypeArray const & | in_types, |
BoolArray const & | in_states | ||
) |
Applies attribute locks that prevents attributes of the chosen types from being modified in child segments.
in_types | An array of attribute types that should be locked or unlocked. |
in_state | An array of bools with each one indicating whether the corresponding type in in_types should be locked. |
AttributeLockKit& AttributeLockKit::SetSubsegmentLockOverride | ( | AttributeLock::Type | in_type, |
bool | in_state = true |
||
) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. This method designates a particular lock as a "super lock" that cannot be overridden by subsegments.
in_type | The type of attribute lock that should be ignored in subsegments. |
in_state | Whether the attribute lock should override locks in subsegments. |
AttributeLockKit& AttributeLockKit::SetSubsegmentLockOverride | ( | AttributeLockTypeArray const & | in_types, |
BoolArray const & | in_states | ||
) |
Normally, if a segment applies an attribute lock it will defeat an existing lock set in a parent segment. This method designates a collection of locks as a "super locks" that cannot be overridden by subsegments.
in_type | Ann array of types of attribute locks that should be ignored in subsegments. |
in_state | An array of bools with each one indicating whether the corresponding attribute lock in in_types should override locks in subsegments. |
void AttributeLockKit::Show | ( | AttributeLockKit & | out_kit | ) | const |
Copies this object into the given AttributeLockKit.
out_kit | The AttributeLockKit to populate with the contents of this object. |
bool AttributeLockKit::ShowLock | ( | AttributeLock::Type | in_type, |
bool & | out_state | ||
) | const |
Shows the state of a particular attribute lock.
in_type | The type of attribute lock to be queried. |
out_state | Whether the attribute is locked. |
bool AttributeLockKit::ShowLock | ( | AttributeLockTypeArray & | out_types, |
BoolArray & | out_states | ||
) | const |
Shows the state of all attribute locks.
out_types | An array of types that have an attribute lock setting. |
out_states | An array of bools with each indicating whether the corresponding entry in in_types is locked. |
bool AttributeLockKit::ShowSubsegmentLockOverride | ( | AttributeLock::Type | in_type, |
bool & | out_state | ||
) | const |
Shows the state of a particular subsegment lock override.
in_type | The type of attribute lock to be queried. |
out_state | Whether the attribute lock will override locks in subsegments. |
bool AttributeLockKit::ShowSubsegmentLockOverride | ( | AttributeLockTypeArray & | out_types, |
BoolArray & | out_states | ||
) | const |
Shows the state of all subsegment lock overrides.
out_types | An array of types that have a subsegment lock override setting. |
out_states | An array of bools with each indicating whether the corresponding entry in in_types is will be ignored in subsegments. |
AttributeLockKit& AttributeLockKit::UnsetEverything | ( | ) |
Removes all settings from this object.
AttributeLockKit& AttributeLockKit::UnsetLock | ( | AttributeLock::Type | in_type = AttributeLock::Type::Everything | ) |
Removes an attribute lock setting.
AttributeLockKit& AttributeLockKit::UnsetLock | ( | AttributeLockTypeArray const & | in_types | ) |
Removes a collection of attribute lock settings.
AttributeLockKit& AttributeLockKit::UnsetSubsegmentLockOverride | ( | AttributeLock::Type | in_type = AttributeLock::Type::Everything | ) |
Removes a subsegment lock override setting.
AttributeLockKit& AttributeLockKit::UnsetSubsegmentLockOverride | ( | AttributeLockTypeArray const & | in_types | ) |
Removes a collection of subsegment lock override settings.