< Home

< Table of Contents

REFERENCE MANUAL

HPS.Parasolid.CADModel Class Reference

The CADModel class is a smart pointer. More...

Inheritance diagram for HPS.Parasolid.CADModel:
HPS.CADModel HPS.Component HPS.Sprocket HPS.Object

Public Member Functions

HPS.Component AddEntity (int in_entity_to_add, HPS.Parasolid.FacetTessellationKit in_facet_tessellation, HPS.Parasolid.LineTessellationKit in_line_tessellation, HPS.Component in_owner)
 Renders the entity specified, according to the tessellation options provided. More...
 
HPS.Component AddEntity (int in_entity_to_add, HPS.Parasolid.FacetTessellationKit in_facet_tessellation, HPS.Parasolid.LineTessellationKit in_line_tessellation)
 Renders the entity specified, according to the tessellation options provided. More...
 
 CADModel ()
 The default constructor creates an uninitialized CADModel object. More...
 
 CADModel (HPS.Component in_that)
 This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More...
 
 CADModel (HPS.CADModel in_that)
 This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More...
 
 CADModel (HPS.Parasolid.CADModel in_that)
 This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More...
 
override void Dispose ()
 
HPS.Component GetComponentFromEntity (int in_entity)
 Returns the Component associated with the provided entity. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
- Public Member Functions inherited from HPS.CADModel
HPS.View ActivateDefaultCapture ()
 Creates a new View object corresponding to the default capture for this CADModel. More...
 
 CADModel ()
 The default constructor creates an uninitialized CADModel object. More...
 
 CADModel (HPS.Component in_that)
 This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More...
 
 CADModel (HPS.CADModel in_that)
 This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More...
 
 CADModel (HPS.Model in_that)
 This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More...
 
HPS.Filter[] GetActiveFilters (HPS.View in_view)
 Get a list of the active filters on the given View. More...
 
HPS.Capture[] GetAllCaptures ()
 Get a list of all captures from all subcomponents for this CADModel. More...
 
HPS.Filter[] GetAllFilters ()
 Get a list of all filters from all subcomponents for this CADModel. More...
 
HPS.Component GetComponentFromKey (HPS.Key in_key)
 Find the Component associated with the given Key (if any). More...
 
HPS.ComponentPath GetComponentPath (HPS.KeyPath in_key_path)
 Get the Component path which corresponds to the given KeyPath. More...
 
HPS.ComponentPath GetComponentPath (HPS.SelectionItem in_item)
 Get the Component path which corresponds to the given SelectionItem. More...
 
HPS.Model GetModel ()
 Get the Model associated with this CADModel. More...
 
void ResetVisibility (HPS.Canvas in_canvas, ulong in_layer)
 Resets the visibility in the view specfied by the given Canvas and layer. More...
 
void ResetVisibility (HPS.Canvas in_canvas)
 Resets the visibility in the view specfied by the given Canvas and layer. More...
 
- Public Member Functions inherited from HPS.Component
void AddKey (HPS.Key in_key)
 Adds a key to be associated with this Component. More...
 
void AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include)
 Adds an owner to this Component. More...
 
void AddOwner (HPS.Component in_owner)
 Adds an owner to this Component. More...
 
void AddReference (HPS.Component in_reference)
 Adds a Component as a reference to this Component. More...
 
virtual void Assign (HPS.Component in_that)
 Share the underlying smart-pointer of the Component source. More...
 
 Component ()
 The default constructor creates an uninitialized Component object. More...
 
 Component (HPS.Component in_that)
 The copy constructor creates a Component object that shares the underlying smart-pointer of the source Component. More...
 
void Delete ()
 Removes all references owning Components have to this Component, deletes all owned subcomponents, and deletes any underlying keys. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Component in_that)
 Check if the source Component points to the same underlying impl as this Component. More...
 
HPS.Metadata[] GetAllMetadata ()
 Get all Metadata objects associated with this Component. More...
 
HPS.Component[] GetAllSubcomponents (HPS.Component.ComponentType in_type)
 Gets all components under this Component that have the specified ComponentType mask. More...
 
HPS.Component.ComponentType GetComponentType ()
 Gets the specific format-dependent type this Component represents. More...
 
override int GetHashCode ()
 
HPS.Key[] GetKeys ()
 Get the underlying keys (if any) which represent this Component. More...
 
HPS.Metadata GetMetadata (string in_name)
 Get the single Metadata object with the given name associated with this Component (if present). More...
 
HPS.Component[] GetOwners ()
 Get the Component objects (if any) which "own" this Component. More...
 
HPS.Component[] GetReferences ()
 Get the Component objects (if any) which are referenced by this Component. More...
 
HPS.Component[] GetReferrers ()
 Gets the Component objects which refer to this Component (if any). More...
 
HPS.Component[] GetSubcomponents ()
 Get the subcomponent objects (if any) owned or referenced by this Component. More...
 
bool HasComponentType (HPS.Component.ComponentType in_mask)
 This function indicates whether this Component has the given ComponentType mask. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from HPS.Component
enum  ComponentType : uint {
  None = 0x00000000, GenericMask = 0xFFFFF000, ComponentType.ExchangeComponentMask = 0x00001000, ComponentType.ExchangeModelFile = 0x00001001,
  ComponentType.ExchangeProductOccurrence = 0x00001002, ComponentType.ExchangePartDefinition = 0x00001003, ComponentType.ExchangeView = 0x00001004, ComponentType.ExchangeFilter = 0x00001005,
  ComponentType.ExchangeRepresentationItemMask = 0x00003000, ComponentType.ExchangeRIBRepModel = 0x00003001, ComponentType.ExchangeRICurve = 0x00003002, ComponentType.ExchangeRIDirection = 0x00003003,
  ComponentType.ExchangeRIPlane = 0x00003004, ComponentType.ExchangeRIPointSet = 0x00003005, ComponentType.ExchangeRIPolyBRepModel = 0x00003006, ComponentType.ExchangeRIPolyWire = 0x00003007,
  ComponentType.ExchangeRISet = 0x00003008, ComponentType.ExchangeRICoordinateSystem = 0x00003009, ComponentType.ExchangeTopologyMask = 0x00005000, ComponentType.ExchangeTopoBody = 0x00005001,
  ComponentType.ExchangeTopoConnex = 0x00005002, ComponentType.ExchangeTopoShell = 0x00005003, ComponentType.ExchangeTopoFace = 0x00005004, ComponentType.ExchangeTopoLoop = 0x00005005,
  ComponentType.ExchangeTopoCoEdge = 0x00005006, ComponentType.ExchangeTopoEdge = 0x00005007, ComponentType.ExchangeTopoVertex = 0x00005008, ComponentType.ExchangeTopoSingleWireBody = 0x00005009,
  ComponentType.ExchangeTopoWireEdge = 0x0000500A, ComponentType.ExchangeDrawingMask = 0x00006000, ComponentType.ExchangeDrawingModel = 0x00006001, ComponentType.ExchangeDrawingView = 0x00006002,
  ComponentType.ExchangeDrawingSheet = 0x00006003, ComponentType.ExchangeBasicDrawingBlock = 0x00006004, ComponentType.ExchangeOperatorDrawingBlock = 0x00006005, ComponentType.ExchangePMIMask = 0x00009000,
  ComponentType.ExchangePMI = 0x00009000, ComponentType.ExchangePMIText = 0x00009100, ComponentType.ExchangePMIRichText = 0x00009200, ComponentType.ExchangePMIRoughness = 0x00009300,
  ComponentType.ExchangePMIGDT = 0x00009400, ComponentType.ExchangePMIDatum = 0x00009500, ComponentType.ExchangePMILineWelding = 0x00009600, ComponentType.ExchangePMISpotWelding = 0x00009700,
  ComponentType.ExchangePMIDimension = 0x00009800, ComponentType.ExchangePMIBalloon = 0x00009900, ComponentType.ExchangePMICoordinate = 0x00009A00, ComponentType.ExchangePMIFastener = 0x00009B00,
  ComponentType.ExchangePMILocator = 0x00009C00, ComponentType.ExchangePMIMeasurementPoint = 0x00009D00, ComponentType.ParasolidComponentMask = 0x00010000, ComponentType.ParasolidModelFile = 0x00010001,
  ComponentType.ParasolidAssembly = 0x00010002, ComponentType.ParasolidTopologyMask = 0x00050000, ComponentType.ParasolidTopoBody = 0x00050001, ComponentType.ParasolidTopoRegion = 0x00050002,
  ComponentType.ParasolidTopoShell = 0x00050003, ComponentType.ParasolidTopoFace = 0x00050004, ComponentType.ParasolidTopoLoop = 0x00050005, ComponentType.ParasolidTopoFin = 0x00050006,
  ComponentType.ParasolidTopoEdge = 0x00050007, ComponentType.ParasolidTopoVertex = 0x00050008
}
 Enumerates the format-dependent types a Component can represent. More...
 
- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Static Public Member Functions inherited from HPS.Component
static HPS.KeyPath[] GetKeyPath (HPS.Component in_component)
 Gets the list of KeyPath objects that correspond to the given Component. More...
 
static HPS.KeyPath[] GetKeyPath (HPS.Component[] in_components)
 Gets the list of KeyPath objects that correspond to the given Component path. More...
 
static bool operator!= (HPS.Component a, HPS.Component b)
 
static bool operator== (HPS.Component a, HPS.Component b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The CADModel class is a smart pointer.

It is an abstract concept symbolizing the root of the Parasolid import. It is not related to any Parasolid object.

Constructor & Destructor Documentation

HPS.Parasolid.CADModel.CADModel ( )

The default constructor creates an uninitialized CADModel object.

The Type() function will return Type::None.

HPS.Parasolid.CADModel.CADModel ( HPS.Component  in_that)

This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component.

The copy will only be successful if the source component is really an upcast of a Parasolid::CADModel object. Otherwise the copy will fail and the resulting Parasolid::CADModel will be invalid.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_parasolid_1_1_component" kindref="compound">Component</ref> to copy.
HPS.Parasolid.CADModel.CADModel ( HPS.CADModel  in_that)

This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component.

The copy will only be successful if the source component is really an upcast of a Parasolid::CADModel object. Otherwise the copy will fail and the resulting Parasolid::CADModel will be invalid.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_parasolid_1_1_component" kindref="compound">Component</ref> to copy.
HPS.Parasolid.CADModel.CADModel ( HPS.Parasolid.CADModel  in_that)

This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component.

The copy will only be successful if the source component is really an upcast of a Parasolid::CADModel object. Otherwise the copy will fail and the resulting Parasolid::CADModel will be invalid.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_parasolid_1_1_component" kindref="compound">Component</ref> to copy.

Member Function Documentation

HPS.Component HPS.Parasolid.CADModel.AddEntity ( int  in_entity_to_add,
HPS.Parasolid.FacetTessellationKit  in_facet_tessellation,
HPS.Parasolid.LineTessellationKit  in_line_tessellation,
HPS.Component  in_owner 
)

Renders the entity specified, according to the tessellation options provided.

Only entities of type PK_CLASS_assembly and PK_CLASS_body can be used with this function.

Parameters
in_entity_to_addThe <ref refid="class_h_p_s_1_1_parasolid" kindref="compound">Parasolid</ref> entity to import into HPS.
in_facet_tessellationThe facet tessellation parameters used during import.
in_line_tessellationThe line tessellation parameters used during import.
in_ownerThe component owning which will own the imported entity
Returns
The component created as part of the import of the provided entity.
HPS.Component HPS.Parasolid.CADModel.AddEntity ( int  in_entity_to_add,
HPS.Parasolid.FacetTessellationKit  in_facet_tessellation,
HPS.Parasolid.LineTessellationKit  in_line_tessellation 
)

Renders the entity specified, according to the tessellation options provided.

Only entities of type PK_CLASS_assembly and PK_CLASS_body can be used with this function.

Parameters
in_entity_to_addThe <ref refid="class_h_p_s_1_1_parasolid" kindref="compound">Parasolid</ref> entity to import into HPS.
in_facet_tessellationThe facet tessellation parameters used during import.
in_line_tessellationThe line tessellation parameters used during import.
Returns
The component created as part of the import of the provided entity.
HPS.Component HPS.Parasolid.CADModel.GetComponentFromEntity ( int  in_entity)

Returns the Component associated with the provided entity.

Parameters
in_entityThe <ref refid="class_h_p_s_1_1_parasolid" kindref="compound">Parasolid</ref> entity for which to return a <ref refid="class_h_p_s_1_1_parasolid_1_1_component" kindref="compound">Component</ref>.
Returns
The component associated with the passed in entity, or an empty component if no component is associated with in_entity.
override HPS.Type HPS.Parasolid.CADModel.ObjectType ( )
virtual

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


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