API Search || Global Search

More...

Inheritance diagram for HPS.DrawingAttributeKit:
HPS.Kit HPS.Object

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 ()
 
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. 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. 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 SetOverrideInternalColor (HPS.VisibilityKit in_kit)
 Specifies internal color of line styles, glyphs and similar items should be overridden. 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 ShowOverrideInternalColor (out HPS.VisibilityKit out_kit)
 Shows the override internal color settings. 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 UnsetOverrideInternalColor ()
 Removes a override internal color 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...
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

HPS.DrawingAttributeKit.DrawingAttributeKit ( )
inline

Initializes an empty kit.

HPS.DrawingAttributeKit.DrawingAttributeKit ( HPS.DrawingAttributeKit  in_kit)
inline

The copy constructor creates a new DrawingAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

Member Function Documentation

override bool HPS.DrawingAttributeKit.Empty ( )
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.

bool HPS.DrawingAttributeKit.Equals ( HPS.DrawingAttributeKit  in_kit)
inline

Check if the source DrawingAttributeKit is equivalent to this object.

Parameters
in_kitThe source DrawingAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.DrawingAttributeKit HPS.DrawingAttributeKit.GetDefault ( )
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.
void HPS.DrawingAttributeKit.Set ( HPS.DrawingAttributeKit  in_kit)
inline

Copies the source DrawingAttributeKit into this object.

Parameters
in_kitThe source object to copy.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion ( HPS.Point[]  in_points,
HPS.Drawing.ClipSpace  in_space,
HPS.Drawing.ClipOperation  in_operation 
)
inline

Sets a polygonal clip region.

Parameters
in_pointsAn array of points describing the clip region.
in_spaceThe coordinate space in which in_points are specified.
in_operationThe operation performed by the clip region.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion ( HPS.Point[]  in_points,
HPS.Drawing.ClipSpace  in_space 
)
inline

Sets a polygonal clip region.

Parameters
in_pointsAn array of points describing the clip region.
in_spaceThe coordinate space in which in_points are specified.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion ( HPS.Point[]  in_points)
inline

Sets a polygonal clip region.

Parameters
in_pointsAn array of points describing the clip region.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion ( HPS.Point  in_loops[][],
HPS.Drawing.ClipSpace  in_space,
HPS.Drawing.ClipOperation  in_operation 
)
inline

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

Parameters
in_loopsAn array of loops describing clip regions.
in_spaceThe coordinate space in which in_loops are specified.
in_operationThe operation performed by the clip region.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion ( HPS.Point  in_loops[][],
HPS.Drawing.ClipSpace  in_space 
)
inline

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

Parameters
in_loopsAn array of loops describing clip regions.
in_spaceThe coordinate space in which in_loops are specified.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion ( HPS.Point  in_loops[][])
inline

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

Parameters
in_loopsAn array of loops describing clip regions.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetDeferral ( int  in_deferral)
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_deferralA drawing priority, with larger values drawing later than usual. Should be non-negative.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetDepthRange ( float  in_near,
float  in_far 
)
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.

HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetFaceDisplacement ( bool  in_state,
int  in_buckets 
)
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_stateWhether face displacement should be used.
in_bucketsThe 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.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetFaceDisplacement ( bool  in_state)
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_stateWhether face displacement should be used.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetFaceDisplacement ( int  in_buckets)
inline

Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera.

Parameters
in_bucketsThe 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.
Returns
A reference to this object.

SetFaceDisplacement(bool in_state, int in_buckets)

HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetGeneralDisplacement ( bool  in_state,
int  in_buckets 
)
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_stateWhether general displacement should be used.
in_bucketsThe 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.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetGeneralDisplacement ( bool  in_state)
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_stateWhether general displacement should be used.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetGeneralDisplacement ( int  in_buckets)
inline

Specifies a number of Z-buffer units that all geometry should be pushed away from the camera.

Parameters
in_bucketsThe 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.
Returns
A reference to this object.

SetGeneralDisplacement(bool in_state, int in_buckets)

HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetOverlay ( HPS.Drawing.Overlay  in_overlay)
inline

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

Parameters
in_overlayThe type of overlay, if any, to be used.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetOverrideInternalColor ( HPS.VisibilityKit  in_kit)
inline

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

Parameters
in_kitWhich types should internal colors should be overridden.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetPolygonHandedness ( HPS.Drawing.Handedness  in_handedness)
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).

HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexDecimation ( float  in_zero_to_one)
inline

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

Parameters
in_zero_to_oneAn amount, between [0,1], of vertices to draw.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexDisplacement ( bool  in_state,
int  in_buckets 
)
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_stateWhether vertex displacement should be used.
in_bucketsThe 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.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexDisplacement ( bool  in_state)
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_stateWhether vertex displacement should be used.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexDisplacement ( int  in_buckets)
inline

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

Parameters
in_bucketsThe 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.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexRandomization ( bool  in_state)
inline

Specifies vertices should be drawn in a random order.

Parameters
in_stateIf true the vertices for a point cloud will be randomized.
Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetWorldHandedness ( HPS.Drawing.Handedness  in_handedness)
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_handednessThe handedness of the underlying coordinate system.
Returns
A reference to this object.

SetPolygonHandedness()

void HPS.DrawingAttributeKit.Show ( out HPS.DrawingAttributeKit  out_kit)
inline

Copies this object into the given DrawingAttributeKit.

Parameters
out_kitThe DrawingAttributeKit to populate with the contents of this object.
bool HPS.DrawingAttributeKit.ShowClipRegion ( out HPS.Point  out_loops[][],
out HPS.Drawing.ClipSpace  out_space,
out HPS.Drawing.ClipOperation  out_operation 
)
inline

Shows the clip region settings.

Parameters
out_loopsAn array of loops describing the clip region.
out_spaceThe coordinate space in which out_loops are described.
out_operationThe operation performed by the clip region
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowDeferral ( out int  out_defer_batch)
inline

Shows the deferral setting.

Parameters
out_defer_batchA 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.
bool HPS.DrawingAttributeKit.ShowDepthRange ( out float  out_near,
out float  out_far 
)
inline

Shows the depth range setting.

Parameters
out_nearThe portion of the depth range closest to the camera. Valid range is [0,1] with out_near <= out_far.
out_farThe 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.
bool HPS.DrawingAttributeKit.ShowFaceDisplacement ( out bool  out_state,
out int  out_buckets 
)
inline

Shows the face displacement setting.

Parameters
out_stateWhether face displacement will be used.
out_bucketsThe distance to move rendered faces away from the camera.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowGeneralDisplacement ( out bool  out_state,
out int  out_buckets 
)
inline

Shows the general displacement setting.

Parameters
out_stateWhether general displacement will be used.
out_bucketsThe distance to move rendered geometry away from the camera.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowOverlay ( out HPS.Drawing.Overlay  out_overlay)
inline

Shows the overlay setting.

Parameters
out_overlayThe type of overlay, if any, used.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowOverrideInternalColor ( out HPS.VisibilityKit  out_kit)
inline

Shows the override internal color settings.

Parameters
out_kitWhich override internal color types will be used.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowPolygonHandedness ( out HPS.Drawing.Handedness  out_handedness)
inline

Shows the polygon handedness.

Parameters
out_handednessThe handedness used for geometry.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowVertexDecimation ( out float  out_zero_to_one)
inline

Shows the vertex decimation setting.

Parameters
out_zero_to_oneThe value set for vertex decimation.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowVertexDisplacement ( out bool  out_state,
out int  out_buckets 
)
inline

Shows the vertex displacement setting.

Parameters
out_stateWhether vertex displacement will be used.
out_bucketsThe distance to move vertices away from the camera.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowVertexRandomization ( out bool  out_state)
inline

Shows the vertex randomization setting.

Parameters
out_stateWhether vertex randomization will be used.
Returns
true if the setting is valid, false otherwise.
bool HPS.DrawingAttributeKit.ShowWorldHandedness ( out HPS.Drawing.Handedness  out_handedness)
inline

Shows the world handedness.

Parameters
out_handednessThe handedness of the underlying coordinate system.
Returns
true if the setting is valid, false otherwise.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetClipRegion ( )
inline

Removes a clip region.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetDeferral ( )
inline

Removes a deferral setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetDepthRange ( )
inline

Removes a depth range setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetFaceDisplacement ( )
inline

Removes a face displacement setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetGeneralDisplacement ( )
inline

Removes a general displacement setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetOverlay ( )
inline

Removes an overlay setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetOverrideInternalColor ( )
inline

Removes a override internal color setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetPolygonHandedness ( )
inline

Removes a polygon handedness setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetVertexDecimation ( )
inline

Removes a vertex decimation setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetVertexDisplacement ( )
inline

Removes a vertex displacement setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetVertexRandomization ( )
inline

Removes a vertex randomization setting.

Returns
A reference to this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetWorldHandedness ( )
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