Inheritance diagram for HPS.Object:

Public Member Functions
virtual void	Dispose ()

virtual bool	Empty ()

IntPtr	GetClassID ()

IntPtr	GetInstanceID ()

bool	HasType (HPS.Type in_mask)

	Object (HPS.Object that)

virtual HPS.Type	ObjectType ()

virtual void	Reset ()

virtual HPS.Type	Type ()

Static Public Member Functions
static IntPtr	ClassID< T > ()

Protected Member Functions
virtual void	deleteCptr ()

virtual IntPtr	GetNonDirectorClassID ()

Protected Attributes
bool	cMemOwn

HandleRef	cptr

Detailed Description

The Object class is the common base class of most Visualize classes.

Member Function Documentation

◆ Empty()

virtual bool HPS.Object.Empty ( )

inlinevirtual

Indicates whether this object has any values set on it.

Note: An empty object is not necessarily invalid. For example, all fresh new Kits, or Objects that have been reset, are both valid and empty.

Returns: true if no values are set on this object, false otherwise.

See also: HPS.Object.Reset()

◆ GetInstanceID()

IntPtr HPS.Object.GetInstanceID ( )

inline

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.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource. This means it would be 4 bytes on a 32-bit system and 8 bytes on a 64-bit system.

◆ HasType()

bool HPS.Object.HasType ( HPS.Type in_mask )

inline

This function indicates whether this Object has the given Type mask.

Warning: This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

virtual HPS.Type HPS.Object.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.

◆ Reset()

virtual void HPS.Object.Reset ( )

inlinevirtual

Resets this object to its initial, uninitialized state.

Reimplemented in HPS.EventHandler, HPS.SelectionResults, HPS.FontSearchResultsIterator, HPS.HighlightSearchResultsIterator, HPS.OptimizeMappingResultsIterator, HPS.SearchResultsIterator, HPS.SelectionResultsIterator, HPS.FontSearchResults, HPS.HighlightSearchResults, HPS.OptimizeMappingResults, and HPS.SearchResults.

◆ Type()

virtual HPS.Type HPS.Object.Type ( )

inlinevirtual

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.

Warning: This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.

Returns: The true type of the object in question.

Reimplemented in HPS.ModellingMatrixControl, HPS.DrawingAttributeControl, HPS.UpdateOptionsControl, HPS.HighlightControl, HPS.SelectionOptionsControl, HPS.StandAloneWindowOptionsControl, HPS.ApplicationWindowOptionsControl, HPS.AttributeLockControl, HPS.OffScreenWindowOptionsControl, HPS.EdgeAttributeControl, HPS.HiddenLineAttributeControl, HPS.LightingAttributeControl, HPS.LineAttributeControl, HPS.MarkerAttributeControl, HPS.MaterialMappingControl, HPS.NURBSSurfaceAttributeControl, HPS.PerformanceControl, HPS.SelectabilityControl, HPS.SubwindowControl, HPS.TextAttributeControl, HPS.TransparencyControl, HPS.VisibilityControl, HPS.VisualEffectsControl, HPS.BoundingControl, HPS.CameraControl, HPS.ColorInterpolationControl, HPS.ConditionControl, HPS.ContourLineControl, HPS.CullingControl, HPS.CurveAttributeControl, HPS.CuttingSectionAttributeControl, HPS.CylinderAttributeControl, HPS.DebuggingControl, HPS.PortfolioControl, HPS.PostProcessEffectsControl, HPS.SphereAttributeControl, HPS.StyleControl, HPS.TextureMatrixControl, HPS.TransformMaskControl, HPS.WindowInfoControl, HPS.Kit, and HPS.Control.

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

internals/hps_core/source/cs/HPS.Object.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ Empty()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ Reset()

◆ Type()