Inheritance diagram for HPS.AttributeLockKit:
HPS.Kit HPS.Object

Public Member Functions

 AttributeLockKit ()
 
 AttributeLockKit (HPS.AttributeLockKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.AttributeLockKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.AttributeLockKit in_kit)
 
HPS.AttributeLockKit SetLock (HPS.AttributeLock.Type in_type, bool in_state)
 
HPS.AttributeLockKit SetLock (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockKit SetLock (HPS.AttributeLock.Type[] in_types, bool[] in_states)
 
HPS.AttributeLockKit SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type, bool in_state)
 
HPS.AttributeLockKit SetSubsegmentLockOverride (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockKit SetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types, bool[] in_states)
 
void Show (out HPS.AttributeLockKit out_kit)
 
bool ShowLock (HPS.AttributeLock.Type in_type, out bool out_state)
 
bool ShowLock (out HPS.AttributeLock.Type[] out_types, out bool[] out_states)
 
bool ShowSubsegmentLockOverride (HPS.AttributeLock.Type in_type, out bool out_state)
 
bool ShowSubsegmentLockOverride (out HPS.AttributeLock.Type[] out_types, out bool[] out_states)
 
HPS.AttributeLockKit UnsetEverything ()
 
HPS.AttributeLockKit UnsetLock (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockKit UnsetLock ()
 
HPS.AttributeLockKit UnsetLock (HPS.AttributeLock.Type[] in_types)
 
HPS.AttributeLockKit UnsetSubsegmentLockOverride (HPS.AttributeLock.Type in_type)
 
HPS.AttributeLockKit UnsetSubsegmentLockOverride ()
 
HPS.AttributeLockKit UnsetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types)
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.AttributeLockKit GetDefault ()
 
static bool operator!= (HPS.AttributeLockKit a, HPS.AttributeLockKit b)
 
static bool operator== (HPS.AttributeLockKit a, HPS.AttributeLockKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ AttributeLockKit() [1/2]

HPS.AttributeLockKit.AttributeLockKit ( )
inline

Initializes an empty kit.

◆ AttributeLockKit() [2/2]

HPS.AttributeLockKit.AttributeLockKit ( HPS.AttributeLockKit  in_kit)
inline

Copies the kit in_kit into this kit.

Member Function Documentation

◆ Empty()

override bool HPS.AttributeLockKit.Empty ( )
inlinevirtual

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.

◆ Equals()

bool HPS.AttributeLockKit.Equals ( HPS.AttributeLockKit  in_kit)
inline

Check if the source AttributeLockKit is equivalent to this object.

Parameters
in_kitThe source AttributeLockKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.AttributeLockKit HPS.AttributeLockKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.AttributeLockKit.ObjectType ( )
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.Object.

◆ Set()

void HPS.AttributeLockKit.Set ( HPS.AttributeLockKit  in_kit)
inline

Copies the source AttributeLockKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetLock() [1/3]

HPS.AttributeLockKit HPS.AttributeLockKit.SetLock ( HPS.AttributeLock.Type  in_type,
bool  in_state 
)
inline

Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.

Parameters
in_typeThe type of attribute to lock or unlock.
in_stateWhether the attribute should be locked.
Returns
A reference to this object.
See also
Attribute lock default value

◆ SetLock() [2/3]

HPS.AttributeLockKit HPS.AttributeLockKit.SetLock ( HPS.AttributeLock.Type  in_type)
inline

Applies an attribute lock that prevents attributes of the chosen type from being modified in child segments.

Parameters
in_typeThe type of attribute to lock or unlock.
Returns
A reference to this object.
See also
Attribute lock default value

◆ SetLock() [3/3]

HPS.AttributeLockKit HPS.AttributeLockKit.SetLock ( HPS.AttributeLock.Type []  in_types,
bool []  in_states 
)
inline

Applies attribute locks that prevents attributes of the chosen types from being modified in child segments.

Parameters
in_typesAn array of attribute types that should be locked or unlocked.
in_statesAn array of bools with each one indicating whether the corresponding type in in_types should be locked.
Returns
A reference to this object.

◆ SetSubsegmentLockOverride() [1/3]

HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type,
bool  in_state 
)
inline

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_typeThe type of attribute lock that should be ignored in subsegments.
in_stateWhether the attribute lock should override locks in subsegments.
Returns
A reference to this object.

◆ SetSubsegmentLockOverride() [2/3]

HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type)
inline

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_typeThe type of attribute lock that should be ignored in subsegments.
Returns
A reference to this object.

◆ SetSubsegmentLockOverride() [3/3]

HPS.AttributeLockKit HPS.AttributeLockKit.SetSubsegmentLockOverride ( HPS.AttributeLock.Type []  in_types,
bool []  in_states 
)
inline

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_typesAn array of types of attribute locks that should be ignored in subsegments.
in_statesAn 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.

◆ Show()

void HPS.AttributeLockKit.Show ( out HPS.AttributeLockKit  out_kit)
inline

Copies this object into the given AttributeLockKit.

Parameters
out_kitThe AttributeLockKit to populate with the contents of this object.

◆ ShowLock() [1/2]

bool HPS.AttributeLockKit.ShowLock ( HPS.AttributeLock.Type  in_type,
out bool  out_state 
)
inline

Shows the state of a particular attribute lock.

Parameters
in_typeThe type of attribute lock to be queried.
out_stateWhether the attribute is locked.
Returns
true if the setting is valid, false otherwise.

◆ ShowLock() [2/2]

bool HPS.AttributeLockKit.ShowLock ( out HPS.AttributeLock.Type []  out_types,
out bool []  out_states 
)
inline

Shows the state of all attribute locks.

Parameters
out_typesAn array of types that have an attribute lock setting.
out_statesAn array of bools with each indicating whether the corresponding entry in in_types is locked.
Returns
true if the setting is valid, false otherwise.

◆ ShowSubsegmentLockOverride() [1/2]

bool HPS.AttributeLockKit.ShowSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type,
out bool  out_state 
)
inline

Shows the state of a particular subsegment lock override.

Parameters
in_typeThe type of attribute lock to be queried.
out_stateWhether the attribute lock will override locks in subsegments.
Returns
true if the setting is valid, false otherwise.

◆ ShowSubsegmentLockOverride() [2/2]

bool HPS.AttributeLockKit.ShowSubsegmentLockOverride ( out HPS.AttributeLock.Type []  out_types,
out bool []  out_states 
)
inline

Shows the state of all subsegment lock overrides.

Parameters
out_typesAn array of types that have a subsegment lock override setting.
out_statesAn 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.

◆ UnsetEverything()

HPS.AttributeLockKit HPS.AttributeLockKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetLock() [1/3]

HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock ( HPS.AttributeLock.Type  in_type)
inline

Removes an attribute lock setting.

Returns
A reference to this object.

◆ UnsetLock() [2/3]

HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock ( )
inline

Removes an attribute lock setting.

Returns
A reference to this object.

◆ UnsetLock() [3/3]

HPS.AttributeLockKit HPS.AttributeLockKit.UnsetLock ( HPS.AttributeLock.Type []  in_types)
inline

Removes a collection of attribute lock settings.

Returns
A reference to this object.

◆ UnsetSubsegmentLockOverride() [1/3]

HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride ( HPS.AttributeLock.Type  in_type)
inline

Removes a subsegment lock override setting.

Returns
A reference to this object.

◆ UnsetSubsegmentLockOverride() [2/3]

HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride ( )
inline

Removes a subsegment lock override setting.

Returns
A reference to this object.

◆ UnsetSubsegmentLockOverride() [3/3]

HPS.AttributeLockKit HPS.AttributeLockKit.UnsetSubsegmentLockOverride ( HPS.AttributeLock.Type []  in_types)
inline

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:
  • internals/hps_core/source/cs/HPS.AttributeLockKit.cs