IncludeKey
- class HPS.IncludeKey : public HPS.Key
The IncludeKey class is a smart pointer to a database object. It is a handle to an include key created by SegmentKey.IncludeSegment.
Public Functions
- override void Dispose ()
- HPS.SegmentKey GetTarget ()
Gets the target, i.e., the segment to be included, for this IncludeKey.
- Return
The target, i.e., the segment to be included, for this IncludeKey.
- IncludeKey ()
The default constructor creates an uninitialized IncludeKey object. The Type() function will return Type.None.
- IncludeKey (HPS.IncludeKey in_that)
The copy constructor creates a IncludeKey object that shares the underlying smart-pointer of the source IncludeKey.
- Param in_that
The source IncludeKey to copy.
- IncludeKey (HPS.Key in_that)
This constructor creates an IncludeKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an include key. Otherwise the copy will fail and the resulting IncludeKey will be invalid.
- Param in_that
The source Key to copy.
- 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.
- HPS.IncludeKey SetConditionalExpression (HPS.ConditionalExpression in_conditional)
Sets a conditional expression on this IncludeKey. This will either make an unconditional include into a conditional include, or modify the condition for an existing conditional include. The target segment referenced by this include will only be included if a condition satisfying the given conditional expression is set above this include in the tree.
- Param in_conditional
The conditional expression for this IncludeKey.
- Return
A reference to this IncludeKey.
- HPS.IncludeKey SetFilter (HPS.AttributeLock.Type in_type)
Sets an attribute filter on this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Param in_type
The attribute filter to set for this IncludeKey.
- Return
A reference to this IncludeKey.
- HPS.IncludeKey SetFilter (HPS.AttributeLock.Type[] in_types)
Sets an array of attribute filters on this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Param in_types
The array of attribute filters to set for this IncludeKey.
- Return
A reference to this IncludeKey.
- HPS.IncludeKey SetPriority (int in_priority)
Assigns a specific drawing priority value of an include. It affects the order in which the include is visited, if and only if the rendering algorithm is set to Priority.
- Param in_priority
The drawing priority, higher priority items are visited before lower priority items.
- Return
A reference to this object.
- bool ShowConditionalExpression (out HPS.ConditionalExpression out_conditional)
Shows the conditional expression for this IncludeKey.
- Param out_conditional
The conditional expression for this IncludeKey.
- Return
true if a conditional expression is set on this IncludeKey, false otherwise.
- bool ShowFilter (HPS.AttributeLock.Type in_type)
Tests if a specific attribute filter is set on this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Param in_type
The attribute filter to test on this IncludeKey.
- Return
true if the specified atribute filter is active on this IncludeKey, false otherwise.
- bool ShowFilter (out HPS.AttributeLock.Type[] out_types)
Shows an array of the current attribute filters on this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Param out_types
The array of attribute filters currently set on this IncludeKey.
- Return
true if there are attribute filters, false otherwise.
- bool ShowPriority (out int out_priority)
Shows the drawing priority.
- Param out_priority
The drawing priority, higher priority items are drawn on top of lower priority items.
- Return
true if the setting is valid, false otherwise.
- HPS.IncludeKey UnsetConditionalExpression ()
Removes the conditional expression on this IncludeKey. This will turn a conditional include into an unconditional include.
- Return
A reference to this IncludeKey.
- HPS.IncludeKey UnsetFilter (HPS.AttributeLock.Type in_type)
Removes an attribute filter from this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Param in_type
The attribute filter to remove from this IncludeKey.
- Return
A reference to this IncludeKey.
- HPS.IncludeKey UnsetFilter (HPS.AttributeLock.Type[] in_types)
Removes an array of attribute filters from this IncludeKey. Attribute filters block the specified attributes set in the tree rooted at the target segment from taking effect for this IncludeKey.
- Param in_types
The array of attribute filters to remove from this IncludeKey.
- Return
A reference to this IncludeKey.
- HPS.IncludeKey UnsetPriority ()
Removes a drawing priority setting.
- Return
A reference to this object.
