HPS.SolidLinePatternElement Class Reference

Inheritance diagram for HPS.SolidLinePatternElement:

Public Member Functions
override void	Dispose ()
override HPS.Type	ObjectType ()
void	SetColor (HPS.RGBAColor in_color)
void	SetMaterialByIndex (float in_material_index)
bool	ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_color, out float out_index)
	SolidLinePatternElement ()
	SolidLinePatternElement (HPS.LinePatternElement in_that)
	SolidLinePatternElement (HPS.SolidLinePatternElement in_that)
	SolidLinePatternElement (float in_size, HPS.LinePattern.SizeUnits in_units)
Public Member Functions inherited from HPS.LinePatternElement
override bool	Equals (System.Object obj)
bool	Equals (HPS.LinePatternElement in_that)
override int	GetHashCode ()
	LinePatternElement ()
	LinePatternElement (HPS.LinePatternElement in_that)
void	Set (HPS.LinePatternElement in_that)
void	SetSize (float in_size, HPS.LinePattern.SizeUnits in_units)
bool	ShowSize (out float out_size, out HPS.LinePattern.SizeUnits out_units)
Public Member Functions inherited from HPS.Object
virtual bool	Empty ()
IntPtr	GetClassID ()
IntPtr	GetInstanceID ()
bool	HasType (HPS.Type in_mask)
	Object (HPS.Object that)
virtual void	Reset ()
virtual HPS.Type	Type ()

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

Additional Inherited Members
Static Public Member Functions inherited from HPS.LinePatternElement
static bool	operator!= (HPS.LinePatternElement a, HPS.LinePatternElement b)
static bool	operator== (HPS.LinePatternElement a, HPS.LinePatternElement b)
Static Public Member Functions inherited from HPS.Object
static IntPtr	ClassID< T > ()
Protected Attributes inherited from HPS.Object
bool	cMemOwn
HandleRef	cptr

Detailed Description

The SolidLinePatternElement class is a user space object. It is used for specifying solid elements within a line pattern.

Constructor & Destructor Documentation

SolidLinePatternElement() [1/4]

HPS.SolidLinePatternElement.SolidLinePatternElement ( )

inline

The default constructor creates an empty SolidLinePatternElement object.

SolidLinePatternElement() [2/4]

HPS.SolidLinePatternElement.SolidLinePatternElement ( HPS.LinePatternElement  in_that )

inline

This constructor creates a SolidLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a solid line pattern element. Otherwise the copy will fail and the resulting SolidLinePatternElement will be invalid.

Parameters

in_that

The source LinePatternElement to copy.

SolidLinePatternElement() [3/4]

HPS.SolidLinePatternElement.SolidLinePatternElement ( HPS.SolidLinePatternElement  in_that )

inline

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

Parameters

in_that

The source SolidLinePatternElement to copy.

SolidLinePatternElement() [4/4]

HPS.SolidLinePatternElement.SolidLinePatternElement ( float  in_size, HPS.LinePattern.SizeUnits  in_units  )

inline

This constructor creates a SolidLinePatternElement with a given size.

Parameters

in_size	The length of the SolidLinePatternElement.
in_units	The units for the length of the SolidLinePatternElement.

Member Function Documentation

ObjectType()

override HPS.Type HPS.SolidLinePatternElement.ObjectType ( )

inlinevirtual

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).

Returns

The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.LinePatternElement.

SetColor()

void HPS.SolidLinePatternElement.SetColor ( HPS.RGBAColor  in_color )

inline

Sets the color for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.

Parameters

in_color

The color for this SolidLinePatternElement.

SetMaterialByIndex()

void HPS.SolidLinePatternElement.SetMaterialByIndex ( float  in_material_index )

inline

Sets the color (by material index) for this SolidLinePatternElement. If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.

ShowColor()

bool HPS.SolidLinePatternElement.ShowColor ( out HPS.Material.Type  out_type, out HPS.RGBAColor  out_color, out float  out_index  )

inline

Shows the color for this SolidLinePatternElement.

Parameters

out_type	Indicates which of the following arguments is valid.
out_color	The color of this SolidLinePatternElement. This is only valid if out_type is Material.Type.RGBAColor.
out_index	The material index for this SolidLinePatternElement. This is only valid if out_type is Material.Type.MaterialIndex.

Returns

true if a color was set, false otherwise.

---

The documentation for this class was generated from the following file:

• internals/hps_core/source/cs/HPS.SolidLinePatternElement.cs