AttributeLockKit

class HPS.AttributeLockKit : HPS.Kit

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.

Public Functions

AttributeLockKit ()

Initializes an empty kit.

AttributeLockKit (HPS.AttributeLockKit in_kit)

Copies the kit in_kit into this kit.

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return:true if no values are set on this object, false otherwise.

bool Equals (HPS.AttributeLockKit in_kit)

Check if the source AttributeLockKit is equivalent to this object.

Param in_kit:The source AttributeLockKit to compare to this object. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.AttributeLockKit in_kit)

Copies the source AttributeLockKit into this object.

Param in_kit:The source object to copy.

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

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

See also

Attribute lock default value

Param in_type:The type of attribute to lock or unlock. Return:A reference to this object.

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

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

See also

Attribute lock default value

Param in_type:The type of attribute to lock or unlock. Param in_state:Whether the attribute should be locked. Return:A reference to this object.

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

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

Param in_types:An array of attribute types that should be locked or unlocked. Param in_states:  An array of bools with each one indicating whether the corresponding type in in_types should be locked. Return:A reference to this object.

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

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.

Param in_type:The type of attribute lock that should be ignored in subsegments. Return:A reference to this object.

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

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.

Param in_type:The type of attribute lock that should be ignored in subsegments. Param in_state:Whether the attribute lock should override locks in subsegments. Return:A reference to this object.

HPS.AttributeLockKit SetSubsegmentLockOverride (HPS.AttributeLock.Type[] in_types, bool[] 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.

Param in_types:An array of types of attribute locks that should be ignored in subsegments. Param in_states:  An array of bools with each one indicating whether the corresponding attribute lock in in_types should override locks in subsegments. Return:A reference to this object.

void Show (out HPS.AttributeLockKit out_kit)

Copies this object into the given AttributeLockKit.

Param out_kit:The AttributeLockKit to populate with the contents of this object.

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

Shows the state of a particular attribute lock.

Param in_type:The type of attribute lock to be queried. Param out_state:  Whether the attribute is locked. Return:true if the setting is valid, false otherwise.

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

Shows the state of all attribute locks.

Param out_types:  An array of types that have an attribute lock setting. Param out_states:  An array of bools with each indicating whether the corresponding entry in in_types is locked. Return:true if the setting is valid, false otherwise.

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

Shows the state of a particular subsegment lock override.

Param in_type:The type of attribute lock to be queried. Param out_state:  Whether the attribute lock will override locks in subsegments. Return:true if the setting is valid, false otherwise.

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

Shows the state of all subsegment lock overrides.

Param out_types:  An array of types that have a subsegment lock override setting. Param out_states:  An array of bools with each indicating whether the corresponding entry in in_types is will be ignored in subsegments. Return:true if the setting is valid, false otherwise.

HPS.AttributeLockKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.AttributeLockKit UnsetLock ()

Removes an attribute lock setting.

Return:A reference to this object.

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

Removes an attribute lock setting.

Return:A reference to this object.

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

Removes a collection of attribute lock settings.

Return:A reference to this object.

HPS.AttributeLockKit UnsetSubsegmentLockOverride ()

Removes a subsegment lock override setting.

Return:A reference to this object.

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

Removes a subsegment lock override setting.

Return:A reference to this object.

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

Removes a collection of subsegment lock override settings.

Return:A reference to this object.

Public Static Functions

HPS.AttributeLockKit GetDefault ()

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.

Return:An AttributeLockKit with the default settings.

bool operator!= (HPS.AttributeLockKit a, HPS.AttributeLockKit b)

bool operator== (HPS.AttributeLockKit a, HPS.AttributeLockKit b)