#include <hps.h>

Static Public Member Functions | |
static AttributeLockKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::AttributeLockKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The HPS::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 HPS::AttributeLockKit::GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
HPS::AttributeLockKit::AttributeLockKit | ( | ) |
Initializes an empty kit.
HPS::AttributeLockKit::AttributeLockKit | ( | AttributeLockKit const & | in_kit | ) |
Copies the kit in_kit into this kit.
HPS::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.
- Parameters
-
in_that An rvalue reference to a AttributeLockKit to take the impl from.
|
virtual |
Destroy this kit.
Member Function Documentation
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS::Object.
bool HPS::AttributeLockKit::Equals | ( | AttributeLockKit const & | in_kit | ) | const |
Check if the source AttributeLockKit is equivalent to this object.
- Parameters
-
in_kit The source AttributeLockKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
- Returns
- An AttributeLockKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
bool HPS::AttributeLockKit::operator!= | ( | AttributeLockKit const & | in_kit | ) | const |
Check if the source AttributeLockKit is not equivalent to this object.
- Parameters
-
in_kit The source AttributeLockKit to compare to this object.
- Returns
- true if the objects are not equivalent, false otherwise.
AttributeLockKit& HPS::AttributeLockKit::operator= | ( | AttributeLockKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this AttributeLockKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a AttributeLockKit to take the impl from.
- Returns
- A reference to this AttributeLockKit.
AttributeLockKit& HPS::AttributeLockKit::operator= | ( | AttributeLockKit const & | in_kit | ) |
Copies the source AttributeLockKit into this object.
- Parameters
-
in_kit The source AttributeLockKit to copy.
- Returns
- A reference to this object.
bool HPS::AttributeLockKit::operator== | ( | AttributeLockKit const & | in_kit | ) | const |
Check if the source AttributeLockKit is equivalent to this object.
- Parameters
-
in_kit The source AttributeLockKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::AttributeLockKit::Set | ( | AttributeLockKit const & | in_kit | ) |
Copies the source AttributeLockKit into this object.
- Parameters
-
in_kit The source object to copy.
AttributeLockKit& HPS::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.
- Parameters
-
in_type The type of attribute to lock or unlock. in_state Whether the attribute should be locked.
- Returns
- A reference to this object.
- See also
- Attribute lock default value
AttributeLockKit& HPS::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.
- Parameters
-
in_types An array of attribute types that should be locked or unlocked. in_states An array of bools with each one indicating whether the corresponding type in in_types should be locked.
- Returns
- A reference to this object.
AttributeLockKit& HPS::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.
- Parameters
-
in_type The type of attribute lock that should be ignored in subsegments. in_state Whether the attribute lock should override locks in subsegments.
- Returns
- A reference to this object.
AttributeLockKit& HPS::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.
- Parameters
-
in_types An array of types of attribute locks that should be ignored in subsegments. in_states An array of bools with each one indicating whether the corresponding attribute lock in in_types should override locks in subsegments.
- Returns
- A reference to this object.
void HPS::AttributeLockKit::Show | ( | AttributeLockKit & | out_kit | ) | const |
Copies this object into the given AttributeLockKit.
- Parameters
-
out_kit The AttributeLockKit to populate with the contents of this object.
bool HPS::AttributeLockKit::ShowLock | ( | AttributeLock::Type | in_type, |
bool & | out_state | ||
) | const |
Shows the state of a particular attribute lock.
- Parameters
-
in_type The type of attribute lock to be queried. out_state Whether the attribute is locked.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::AttributeLockKit::ShowLock | ( | AttributeLockTypeArray & | out_types, |
BoolArray & | out_states | ||
) | const |
Shows the state of all attribute locks.
- Parameters
-
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.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::AttributeLockKit::ShowSubsegmentLockOverride | ( | AttributeLock::Type | in_type, |
bool & | out_state | ||
) | const |
Shows the state of a particular subsegment lock override.
- Parameters
-
in_type The type of attribute lock to be queried. out_state Whether the attribute lock will override locks in subsegments.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::AttributeLockKit::ShowSubsegmentLockOverride | ( | AttributeLockTypeArray & | out_types, |
BoolArray & | out_states | ||
) | const |
Shows the state of all subsegment lock overrides.
- Parameters
-
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.
- Returns
- true if the setting is valid, false otherwise.
AttributeLockKit& HPS::AttributeLockKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
AttributeLockKit& HPS::AttributeLockKit::UnsetLock | ( | AttributeLock::Type | in_type = AttributeLock::Type::Everything | ) |
Removes an attribute lock setting.
- Returns
- A reference to this object.
AttributeLockKit& HPS::AttributeLockKit::UnsetLock | ( | AttributeLockTypeArray const & | in_types | ) |
Removes a collection of attribute lock settings.
- Returns
- A reference to this object.
AttributeLockKit& HPS::AttributeLockKit::UnsetSubsegmentLockOverride | ( | AttributeLock::Type | in_type = AttributeLock::Type::Everything | ) |
Removes a subsegment lock override setting.
- Returns
- A reference to this object.
AttributeLockKit& HPS::AttributeLockKit::UnsetSubsegmentLockOverride | ( | AttributeLockTypeArray const & | in_types | ) |
Removes a collection of subsegment lock override settings.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h