
Public Member Functions | |
override void | Dispose () |
DrawingAttributeKit () | |
Initializes an empty kit. More... | |
DrawingAttributeKit (HPS.DrawingAttributeKit in_kit) | |
The copy constructor creates a new DrawingAttributeKit object that contains the same settings as the source object. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.DrawingAttributeKit in_kit) |
Check if the source DrawingAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.DrawingAttributeKit in_kit) |
Copies the source DrawingAttributeKit into this object. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[] in_points) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[][] in_loops) |
Sets a complex polygonal clip region defined by the XOR of a series of loops. More... | |
HPS.DrawingAttributeKit | 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 and segments have a default value of 0. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | SetOverlay (HPS.Drawing.Overlay in_overlay) |
Allows moving, editing, or deleting to take place in a segment without triggering a full-screen redraw. More... | |
HPS.DrawingAttributeKit | SetPolygonHandedness (HPS.Drawing.Handedness in_handedness) |
In order to perform back face culling, there must be some definition of a polygon's "front" and "back" faces. 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). More... | |
HPS.DrawingAttributeKit | SetVertexDecimation (float in_zero_to_one) |
Specifies an amount of vertices to draw 1 draws them all. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | 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. More... | |
HPS.DrawingAttributeKit | SetVertexRandomization (bool in_state) |
Specifies vertices should be drawn in a random order. More... | |
HPS.DrawingAttributeKit | 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. More... | |
void | Show (out HPS.DrawingAttributeKit out_kit) |
Copies this object into the given DrawingAttributeKit. More... | |
bool | ShowClipRegion (out HPS.Point[][] out_loops, out HPS.Drawing.ClipSpace out_space, out HPS.Drawing.ClipOperation out_operation) |
Shows the clip region settings. More... | |
bool | ShowDeferral (out int out_defer_batch) |
Shows the deferral setting. More... | |
bool | ShowDepthRange (out float out_near, out float out_far) |
Shows the depth range setting. More... | |
bool | ShowFaceDisplacement (out bool out_state, out int out_buckets) |
Shows the face displacement setting. More... | |
bool | ShowGeneralDisplacement (out bool out_state, out int out_buckets) |
Shows the general displacement setting. More... | |
bool | ShowOverlay (out HPS.Drawing.Overlay out_overlay) |
Shows the overlay setting. More... | |
bool | ShowPolygonHandedness (out HPS.Drawing.Handedness out_handedness) |
Shows the polygon handedness. More... | |
bool | ShowVertexDecimation (out float out_zero_to_one) |
Shows the vertex decimation setting. More... | |
bool | ShowVertexDisplacement (out bool out_state, out int out_buckets) |
Shows the vertex displacement setting. More... | |
bool | ShowVertexRandomization (out bool out_state) |
Shows the vertex randomization setting. More... | |
bool | ShowWorldHandedness (out HPS.Drawing.Handedness out_handedness) |
Shows the world handedness. More... | |
HPS.DrawingAttributeKit | UnsetClipRegion () |
Removes a clip region. More... | |
HPS.DrawingAttributeKit | UnsetDeferral () |
Removes a deferral setting. More... | |
HPS.DrawingAttributeKit | UnsetDepthRange () |
Removes a depth range setting. More... | |
HPS.DrawingAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.DrawingAttributeKit | UnsetFaceDisplacement () |
Removes a face displacement setting. More... | |
HPS.DrawingAttributeKit | UnsetGeneralDisplacement () |
Removes a general displacement setting. More... | |
HPS.DrawingAttributeKit | UnsetOverlay () |
Removes an overlay setting. More... | |
HPS.DrawingAttributeKit | UnsetPolygonHandedness () |
Removes a polygon handedness setting. More... | |
HPS.DrawingAttributeKit | UnsetVertexDecimation () |
Removes a vertex decimation setting. More... | |
HPS.DrawingAttributeKit | UnsetVertexDisplacement () |
Removes a vertex displacement setting. More... | |
HPS.DrawingAttributeKit | UnsetVertexRandomization () |
Removes a vertex randomization setting. More... | |
HPS.DrawingAttributeKit | UnsetWorldHandedness () |
Removes a world handedness setting. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.DrawingAttributeKit | GetDefault () |
Creates a DrawingAttributeKit 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. More... | |
static bool | operator!= (HPS.DrawingAttributeKit a, HPS.DrawingAttributeKit b) |
static bool | operator== (HPS.DrawingAttributeKit a, HPS.DrawingAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.DrawingAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.DrawingAttributeKit.GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new DrawingAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
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.
|
inline |
Check if the source DrawingAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source DrawingAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates a DrawingAttributeKit 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
- A DrawingAttributeKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Copies the source DrawingAttributeKit into this object.
- Parameters
-
in_kit The source object to copy.
|
inline |
Sets a polygonal clip region.
- Parameters
-
in_points An array of points describing the clip region. in_space The coordinate space in which in_points are specified. in_operation The operation performed by the clip region.
- Returns
- A reference to this object.
|
inline |
Sets a polygonal clip region.
- Parameters
-
in_points An array of points describing the clip region. in_space The coordinate space in which in_points are specified.
- Returns
- A reference to this object.
|
inline |
Sets a polygonal clip region.
- Parameters
-
in_points An array of points describing the clip region.
- Returns
- A reference to this object.
|
inline |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
- Parameters
-
in_loops An array of loops describing clip regions. in_space The coordinate space in which in_loops are specified. in_operation The operation performed by the clip region.
- Returns
- A reference to this object.
|
inline |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
- Parameters
-
in_loops An array of loops describing clip regions. in_space The coordinate space in which in_loops are specified.
- Returns
- A reference to this object.
|
inline |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
- Parameters
-
in_loops An array of loops describing clip regions.
- Returns
- A reference to this object.
|
inline |
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 and segments have a default value of 0.
- Parameters
-
in_deferral A drawing priority, with larger values drawing later than usual. Should be non-negative.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
- Parameters
-
in_state Whether face displacement should be used. in_buckets The distance to move rendered faces away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether face displacement should be used.
- Returns
- A reference to this object.
|
inline |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. The state is implicitly on.
- Parameters
-
in_buckets The distance to move rendered faces away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether general displacement should be used. in_buckets The distance to move rendered geometry away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether general displacement should be used.
- Returns
- A reference to this object.
|
inline |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. The state is implicitly on.
- Parameters
-
in_buckets The distance to move rendered geometry away from the camera.
- Returns
- A reference to this object.
|
inline |
Allows moving, editing, or deleting to take place in a segment without triggering a full-screen redraw.
- Parameters
-
in_overlay The type of overlay, if any, to be used.
- Returns
- A reference to this object.
|
inline |
In order to perform back face culling, there must be some definition of a polygon's "front" and "back" faces. 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).
|
inline |
Specifies an amount of vertices to draw 1 draws them all.
- Parameters
-
in_zero_to_one An amount, between [0,1], of vertices to draw.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether vertex displacement should be used. in_buckets The distance to move vertices away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether vertex displacement should be used.
- Returns
- A reference to this object.
|
inline |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera. The state is implicitly on.
- Parameters
-
in_buckets The distance to move rendered geometry away from the camera.
- Returns
- A reference to this object.
|
inline |
Specifies vertices should be drawn in a random order.
- Parameters
-
in_state If true the vertices for a point cloud will be randomized.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_handedness The handedness of the underlying coordinate system.
- Returns
- A reference to this object.
|
inline |
Copies this object into the given DrawingAttributeKit.
- Parameters
-
out_kit The DrawingAttributeKit to populate with the contents of this object.
|
inline |
Shows the clip region settings.
- Parameters
-
out_loops An array of loops describing the clip region. out_space The coordinate space in which out_loops are described. out_operation The operation performed by the clip region
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the deferral setting.
- Parameters
-
out_defer_batch A drawing priority, with negative values drawing earlier than usual and positive values drawing later than usual.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the depth range setting.
- Parameters
-
out_near The portion of the depth range closest to the camera. Valid range is [0,1] with out_near <= out_far. out_far The portion of the depth range furthest to the camera. Valid range is [0,1] with out_near <= out_far.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the face displacement setting.
- Parameters
-
out_state Whether face displacement will be used. out_buckets The distance to move rendered faces away from the camera.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the general displacement setting.
- Parameters
-
out_state Whether general displacement will be used. out_buckets The distance to move rendered geometry away from the camera.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the overlay setting.
- Parameters
-
out_overlay The type of overlay, if any, used.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the polygon handedness.
- Parameters
-
out_handedness The handedness used for geometry.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the vertex decimation setting.
- Parameters
-
out_zero_to_one The value set for vertex decimation.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the vertex displacement setting.
- Parameters
-
out_state Whether vertex displacement will be used. out_buckets The distance to move vertices away from the camera.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the vertex randomization setting.
- Parameters
-
out_state Whether vertex randomization will be used.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the world handedness.
- Parameters
-
out_handedness The handedness of the underlying coordinate system.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Removes a clip region.
- Returns
- A reference to this object.
|
inline |
Removes a deferral setting.
- Returns
- A reference to this object.
|
inline |
Removes a depth range setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes a face displacement setting.
- Returns
- A reference to this object.
|
inline |
Removes a general displacement setting.
- Returns
- A reference to this object.
|
inline |
Removes an overlay setting.
- Returns
- A reference to this object.
|
inline |
Removes a polygon handedness setting.
- Returns
- A reference to this object.
|
inline |
Removes a vertex decimation setting.
- Returns
- A reference to this object.
|
inline |
Removes a vertex displacement setting.
- Returns
- A reference to this object.
|
inline |
Removes a vertex randomization setting.
- Returns
- A reference to this object.
|
inline |
Removes a world handedness setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.DrawingAttributeKit.cs