DrawingAttributeControl

class HPS.DrawingAttributeControl : public HPS.Control 

The HPS.DrawingAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate various high-level settings, such as depth range, priority, and displacement. Note that some of the attributes available through this control should only be set for an entire window, while others can be set at multiple places.

Global attributes:

World handedness, polygon handedness, priority, depth range

Segment-level attributes:

overlay, deferral, face displacement, general displacement, clip regions

This table lists default values for the various segment attributes accessible from HPS.DrawingAttributeControl.

Public Functions

override void Dispose ()

DrawingAttributeControl (HPS.DrawingAttributeControl in_that): Initializes a control tied to the same object as in_that.

DrawingAttributeControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

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.DrawingAttributeControl SetClipRegion (HPS.Point[] in_points)

Specifies a clip region.

Param in_points: An array of points specifying the shape of the clip region.
Return: A reference to this object.

HPS.DrawingAttributeControl SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space)

Specifies a clip region.

Param in_points: An array of points specifying the shape of the clip region.
Param in_space: The space coordinated in which the points are specified.
Return: A reference to this object.

HPS.DrawingAttributeControl SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation)

Specifies a clip region.

Param in_points: An array of points specifying the shape of the clip region.
Param in_space: The space coordinated in which the points are specified.
Param in_operation: The operation performed by this clip region.
Return: A reference to this object.

HPS.DrawingAttributeControl SetClipRegion (HPS.Point[][] in_loops)

Sets a complex polygonal clip region defined by the XOR of a series of loops.

Param in_loops: An array of loops describing clip regions.
Return: A reference to this object.

HPS.DrawingAttributeControl SetClipRegion (HPS.Point[][] in_loops, HPS.Drawing.ClipSpace in_space)

Sets a complex polygonal clip region defined by the XOR of a series of loops.

Param in_loops: An array of loops describing clip regions.
Param in_space: The coordinate space in which in_loops are specified.
Return: A reference to this object.

HPS.DrawingAttributeControl SetClipRegion (HPS.Point[][] in_loops, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation)

Sets a complex polygonal clip region defined by the XOR of a series of loops.

Param in_loops: An array of loops describing clip regions.
Param in_space: The coordinate space in which in_loops are specified.
Param in_operation: The operation performed by the clip region.
Return: A reference to this object.

HPS.DrawingAttributeControl SetDeferral (int in_deferral)

Specifies a drawing order for a segment during timed updates. Segments with a lower deferral value will be drawn before segments with a higher value. This attribute does not inherit like most attributes. Segments have a default value of 0.

Param in_deferral: A drawing priority, with larger values drawing later than usual. Should be non-negative.
Return: A reference to this object.

HPS.DrawingAttributeControl SetDepthRange (float in_near, float in_far)

Compresses effective Z values into a subset of what they would otherwise have been. This allows certain pieces of the scene to be drawn on top at all times without additional sub-windows. Values of (0,0) will force all geometry into the frontmost bucket, but will have the drawback that it will cause z-fighting amongst the geometry that shares that setting. To get such pieces of geometry to resolve reasonably well against each other, a range of (0,0.1) should perform reasonably well. Depth range settings are not cumulative, and have no effect when the rendering algorithm is Priority, or is not set. The default is (0,1)

Param in_near: The portion of the depth range closest to the camera. Valid range is [0,1] with in_near <= in_far.
Param in_far: The portion of the depth range furthest to the camera. Valid range is [0,1] with in_near <= in_far.
Return: A reference to this object.

HPS.DrawingAttributeControl SetFaceDisplacement (bool in_state)

Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. This can be used to reduce edge stitching by ensuring that coincident edges lay on top of the faces. Negative face displacements will push faces toward the camera.

Param in_state: Whether face displacement should be used.
Return: A reference to this object.

HPS.DrawingAttributeControl SetFaceDisplacement (bool in_state, int in_buckets)

Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. This can be used to reduce edge stitching by ensuring that coincident edges lay on top of the faces. Negative face displacements will push faces toward the camera.

Param in_state: Whether face displacement should be used.
Param in_buckets: The number of units to move faces in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move faces toward the camera, positive values away from the camera.
Return: A reference to this object.

HPS.DrawingAttributeControl SetFaceDisplacement (int in_buckets)

Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. The state is implicitly on.

See: SetFaceDisplacement(bool in_state, int in_buckets)

Param in_buckets: The number of units to move faces in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move faces toward the camera, positive values away from the camera.
Return: A reference to this object.

HPS.DrawingAttributeControl SetGeneralDisplacement (bool in_state)

Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. This can be used to ensure that certain geometry is drawn on top of or behind the rest of the scene. Negative general displacements will push geometry toward the camera.

Param in_state: Whether general displacement should be used.
Return: A reference to this object.

HPS.DrawingAttributeControl SetGeneralDisplacement (bool in_state, int in_buckets)

Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. This can be used to ensure that certain geometry is drawn on top of or behind the rest of the scene. Negative general displacements will push geometry toward the camera.

Param in_state: Whether general displacement should be used.
Param in_buckets: The number of units to move rendered geometry in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move geometry toward the camera, positive values away from the camera.
Return: A reference to this object.

HPS.DrawingAttributeControl SetGeneralDisplacement (int in_buckets)

Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. The state is implicitly on.

See: SetGeneralDisplacement(bool in_state, int in_buckets)

Param in_buckets: The number of units to move rendered geometry in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move geometry toward the camera, positive values away from the camera.
Return: A reference to this object.

HPS.DrawingAttributeControl SetOverlay (HPS.Drawing.Overlay in_overlay)

Allows moving, editing, or deleting to take place in a segment without triggering a full-screen redraw.

Param in_overlay: The type of overlay, if any, to be used.
Return: A reference to this object.

HPS.DrawingAttributeControl SetOverrideInternalColor (HPS.VisibilityKit in_kit)

Specifies internal color of line styles, glyphs and similar items should be overridden.

Param in_kit: Which types should internal colors should be overridden.
Return: A reference to this object.

HPS.DrawingAttributeControl SetPolygonHandedness (HPS.Drawing.Handedness in_handedness)

In order to do a back face culling, there must be some definition of a polygon’s “front” and “back”. This orientation is determined by the order in which the polygon’s vertices were originally defined and the polygon handedness setting (not the world handedness). If you wrap the fingers of the chosen hand along the vertices of the polygon, with your wrist at the first vertex and your fingertips at the last, then extend your thumb perpendicular to your fingers, your thumb is extending out of the front face of the polygon.

See: SetWorldHandedness()
See: CullingKit.SetBackFace()

Param in_handedness: The handedness to be used for geometry.
Return: A reference to this object.

HPS.DrawingAttributeControl SetVertexDecimation (float in_zero_to_one)

Specifies an amount of vertices to draw 1 draws them all.

Param in_zero_to_one: An amount, between [0,1], of vertices to draw.
Return: A reference to this object.

HPS.DrawingAttributeControl SetVertexDisplacement (bool in_state)

Specifies a number of Z-buffer units that vertices should be pushed away from the camera. This can be used to ensure that vertices are drawn on top of or behind other geometry. Negative general displacements will push vertices toward the camera.

Param in_state: Whether vertex displacement should be used.
Return: A reference to this object.

HPS.DrawingAttributeControl SetVertexDisplacement (bool in_state, int in_buckets)

Specifies a number of Z-buffer units that vertices should be pushed away from the camera. This can be used to ensure that vertices are drawn on top of or behind other geometry. Negative general displacements will push vertices toward the camera.

Param in_state: Whether vertex displacement should be used.
Param in_buckets: The number of units to move vertices in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move vertices toward the camera, positive values away from the camera.
Return: A reference to this object.

HPS.DrawingAttributeControl SetVertexDisplacement (int in_buckets)

Specifies a number of Z-buffer units that vertices should be pushed away from the camera. The state is implicitly on.

Param in_buckets: The number of units to move vertices in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move vertices toward the camera, positive values away from the camera.
Return: A reference to this object.

HPS.DrawingAttributeControl SetVertexRandomization (bool in_state)

Specifies vertices should be drawn in a random order.

Param in_state: If true the vertices for a point cloud will be randomized.
Return: A reference to this object.

HPS.DrawingAttributeControl SetWorldHandedness (HPS.Drawing.Handedness in_handedness)

The world handedness determines the orientation of the Z-axis in the Cartesian coordinate system. If you curl the fingers of your appropriate hand from the X-axis towards the Y-axis, your thumb will point in the direction of the Z-axis.

See: SetPolygonHandedness()

Param in_handedness: The handedness of the underlying coordinate system.
Return: A reference to this object.

bool ShowClipRegion (out HPS.Point[][] out_loops, out HPS.Drawing.ClipSpace out_space, out HPS.Drawing.ClipOperation out_operation)

Shows the clip region setting.

Param out_loops: An array of loops specifying the shape of the clip region.
Param out_space: The coordinate space the points are specified in.
Param out_operation: The operation performed by this clip region.
Return: true if the setting is valid, false otherwise.

bool ShowDeferral (out int out_defer_batch)

Shows the deferral setting.

Param out_defer_batch: A drawing priority, with negative values drawing earlier than usual and positive values drawing later than usual.
Return: true if the setting is valid, false otherwise.

bool ShowDepthRange (out float out_x, out float out_y)

Shows the depth range setting.

Return: true if the setting is valid, false otherwise.

bool ShowFaceDisplacement (out bool out_state, out int out_buckets)

Shows the face displacement setting.

Param out_state: Whether face displacement will be used.
Param out_buckets: The distance to move rendered faces away from the camera.
Return: true if the setting is valid, false otherwise.

bool ShowGeneralDisplacement (out bool out_state, out int out_buckets)

Shows the general displacement setting.

Param out_state: Whether general displacement will be used.
Param out_buckets: The distance to move rendered geometry away from the camera.
Return: true if the setting is valid, false otherwise.

bool ShowOverlay (out HPS.Drawing.Overlay out_overlay)

Shows the overlay setting.

Param out_overlay: The type of overlay, if any, used.
Return: true if the setting is valid, false otherwise.

bool ShowOverrideInternalColor (out HPS.VisibilityKit out_kit)

Shows the override internal color setting.

Param out_kit: Which override internal color types will be used.
Return: true if the setting is valid, false otherwise.

bool ShowPolygonHandedness (out HPS.Drawing.Handedness out_handedness)

Shows the polygon handedness.

Param out_handedness: The handedness used for geometry.
Return: true if the setting is valid, false otherwise.

bool ShowVertexDecimation (out float out_zero_to_one)

Shows the vertex decimation setting.

Param out_zero_to_one: The value set for vertex decimation.
Return: true if the setting is valid, false otherwise.

bool ShowVertexDisplacement (out bool out_state, out int out_buckets)

Shows the vertex displacement setting.

Param out_state: Whether vertex displacement will be used.
Param out_buckets: The distance to move vertices away from the camera.
Return: true if the setting is valid, false otherwise.

bool ShowVertexRandomization (out bool out_state)

Shows the vertex randomization setting.

Param out_state: Whether vertex randomization will be used.
Return: true if the setting is valid, false otherwise.

bool ShowWorldHandedness (out HPS.Drawing.Handedness out_handedness)

Shows the world handedness.

Param out_handedness: The handedness of the underlying coordinate system.
Return: true if the setting is valid, false otherwise.

HPS.DrawingAttributeControl UnsetClipRegion ()

Removes a clip region setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetDeferral ()

Removes a deferral setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetDepthRange ()

Removes a depth range setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetEverything ()

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetFaceDisplacement ()

Removes a face displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetGeneralDisplacement ()

Removes a general displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetOverlay ()

Removes an overlay setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetOverrideInternalColor ()

Removes an override internal color setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetPolygonHandedness ()

Removes a polygon handedness setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetVertexDecimation ()

Removes a vertex decimation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetVertexDisplacement ()

Removes a vertex displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetVertexRandomization ()

Removes a vertex randomization setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.

HPS.DrawingAttributeControl UnsetWorldHandedness ()

Removes a world handedness setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().

Return: A reference to this object.