REFERENCE MANUAL
The ReferenceKey class is a smart pointer to a database object. More...
Public Member Functions | |
override void | Dispose () |
HPS.ModellingMatrixControl | GetModellingMatrixControl () |
Gets a control that allows querying and modifying modelling matrices set on this reference. More... | |
HPS.Key | GetTarget () |
Gets the geometry or segment key that was used to create this ReferenceKey. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
ReferenceKey () | |
The default constructor creates an uninitialized ReferenceKey object. More... | |
ReferenceKey (HPS.Key in_that) | |
This constructor creates an ReferenceKey object that shares the underlying smart-pointer of the source Key. More... | |
ReferenceKey (HPS.ReferenceKey in_that) | |
This constructor creates an ReferenceKey object that shares the underlying smart-pointer of the source Key. More... | |
HPS.ReferenceKey | SetCondition (HPS.Condition in_condition) |
Sets a conditional expression on this ReferenceKey. More... | |
HPS.ReferenceKey | SetGeometryMask (HPS.Search.Type[] in_geometry_types) |
Sets the masked geometry types. More... | |
void | SetModellingMatrix (HPS.MatrixKit in_kit) |
Sets the specified modelling matrix on this reference. More... | |
bool | ShowCondition (out HPS.Condition out_condition) |
Shows the conditional expression for this ReferenceKey. More... | |
ulong | ShowGeometryMask () |
Gets the count of masked geometry types. More... | |
ulong | ShowGeometryMask (out HPS.Search.Type[] out_geometry_types) |
Gets the masked geometry types. More... | |
bool | ShowModellingMatrix (out HPS.MatrixKit out_kit) |
Shows the modelling matrix on this reference. More... | |
ulong | ShowTargets (bool masked) |
Gets the count of geometry keys or a segment key targeted by this ReferenceKey. More... | |
ulong | ShowTargets () |
Gets the count of geometry keys or a segment key targeted by this ReferenceKey. More... | |
ulong | ShowTargets (out HPS.Key[] out_keys, bool masked) |
Gets the geometries keys or a segment key targeted by this ReferenceKey. More... | |
ulong | ShowTargets (out HPS.Key[] out_keys) |
Gets the geometries keys or a segment key targeted by this ReferenceKey. More... | |
HPS.ReferenceKey | UnsetCondition () |
Removes the conditional expression on this ReferenceKey. More... | |
HPS.ReferenceKey | UnsetGeometryMask () |
Resets the masked geometry types on this ReferenceKey to Search::Type::Geometry. More... | |
void | UnsetModellingMatrix () |
Removes the modelling matrix on this geometry reference. More... | |
![]() | |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this key. More... | |
bool | ShowBoundings (out HPS.BoundingKit out_kit) |
Shows the bounding of this geometry. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
Shows the all the segments which contain references to this key. More... | |
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
Shows the all the references to this key. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this key. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this key. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this key. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this key. More... | |
HPS.GeometryKey | UnsetAllUserData () |
Removes all user data from this key. More... | |
HPS.GeometryKey | UnsetPriority () |
Removes the drawing priority setting. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this key. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this key. More... | |
![]() | |
virtual void | Assign (HPS.Key in_that) |
Share the smart-pointer. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. More... | |
void | Delete () |
Removes the database object referred to by this key. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Key in_that) |
Determines whether the database objects pointed to by this key and in_that are the same. More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
Key () | |
An uninitialized key refers to no database object and Type() will return Type::None. More... | |
Key (HPS.Key in_that) | |
Shares a reference to a database object referred to by in_that. More... | |
Key (HPS.Control in_control) | |
Initializes a key tied to the Control in_control. More... | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ReferenceKey class is a smart pointer to a database object.
It is a handle to a geometry reference returned by SegmentKey::ReferenceGeometry.
HPS.ReferenceKey.ReferenceKey | ( | ) |
The default constructor creates an uninitialized ReferenceKey object.
The Type() function will return Type::None.
HPS.ReferenceKey.ReferenceKey | ( | HPS.Key | in_that | ) |
This constructor creates an ReferenceKey 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 a reference key. Otherwise the copy will fail and the resulting ReferenceKey will be invalid.
HPS.ReferenceKey.ReferenceKey | ( | HPS.ReferenceKey | in_that | ) |
This constructor creates an ReferenceKey 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 a reference key. Otherwise the copy will fail and the resulting ReferenceKey will be invalid.
HPS.ModellingMatrixControl HPS.ReferenceKey.GetModellingMatrixControl | ( | ) |
Gets a control that allows querying and modifying modelling matrices set on this reference.
HPS.Key HPS.ReferenceKey.GetTarget | ( | ) |
Gets the geometry or segment key that was used to create this ReferenceKey.
If multiple geometry are referenced only the first is returned.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.GeometryKey.
HPS.ReferenceKey HPS.ReferenceKey.SetCondition | ( | HPS.Condition | in_condition | ) |
Sets a conditional expression on this ReferenceKey.
This will either make an unconditional reference into a conditional reference, or modify the condition for an existing conditional reference. The target geometry or segment referenced by this reference will only be drawn in the owning segment if a condition satisfying the given conditional expression is set above this reference in the tree.
in_condition | The conditional expression for this <ref refid="class_h_p_s_1_1_reference_key" kindref="compound">ReferenceKey</ref>. |
HPS.ReferenceKey HPS.ReferenceKey.SetGeometryMask | ( | HPS.Search.Type[] | in_geometry_types | ) |
Sets the masked geometry types.
Only the geometry types included in the mask will be processed by this ReferenceKey. Set Search::Type::Geometry to process all geometry types.
in_geometry_types | The geometry types to be processed by this reference. |
void HPS.ReferenceKey.SetModellingMatrix | ( | HPS.MatrixKit | in_kit | ) |
Sets the specified modelling matrix on this reference.
in_kit | The modelling matrix to set on this reference. |
bool HPS.ReferenceKey.ShowCondition | ( | out HPS.Condition | out_condition | ) |
Shows the conditional expression for this ReferenceKey.
out_condition | The conditional expression for this <ref refid="class_h_p_s_1_1_reference_key" kindref="compound">ReferenceKey</ref>. |
ulong HPS.ReferenceKey.ShowGeometryMask | ( | ) |
Gets the count of masked geometry types.
Only the geometry types included in the mask will be processed by this ReferenceKey. If no mask was explicitly set the mask size is one and the value is Search::Type::Geometry.
ulong HPS.ReferenceKey.ShowGeometryMask | ( | out HPS.Search.Type[] | out_geometry_types | ) |
Gets the masked geometry types.
Only the geometry types included in the mask will be processed by this ReferenceKey. If no mask was explicitly set the mask size is one and the value is Search::Type::Geometry.
out_geometry_types | The geometry types processed by this reference. |
bool HPS.ReferenceKey.ShowModellingMatrix | ( | out HPS.MatrixKit | out_kit | ) |
Shows the modelling matrix on this reference.
out_kit | The modelling matrix set on this reference. |
ulong HPS.ReferenceKey.ShowTargets | ( | bool | masked | ) |
Gets the count of geometry keys or a segment key targeted by this ReferenceKey.
masked | If true a geometry mask if present will be applied to the results. |
ulong HPS.ReferenceKey.ShowTargets | ( | ) |
Gets the count of geometry keys or a segment key targeted by this ReferenceKey.
ulong HPS.ReferenceKey.ShowTargets | ( | out HPS.Key[] | out_keys, |
bool | masked | ||
) |
Gets the geometries keys or a segment key targeted by this ReferenceKey.
out_keys | The keys targeted by this reference. |
masked | If true a geometry mask if present will be applied to the results. |
ulong HPS.ReferenceKey.ShowTargets | ( | out HPS.Key[] | out_keys | ) |
Gets the geometries keys or a segment key targeted by this ReferenceKey.
out_keys | The keys targeted by this reference. |
HPS.ReferenceKey HPS.ReferenceKey.UnsetCondition | ( | ) |
Removes the conditional expression on this ReferenceKey.
This will turn a conditional reference into an unconditional reference.
HPS.ReferenceKey HPS.ReferenceKey.UnsetGeometryMask | ( | ) |
Resets the masked geometry types on this ReferenceKey to Search::Type::Geometry.
void HPS.ReferenceKey.UnsetModellingMatrix | ( | ) |
Removes the modelling matrix on this geometry reference.