All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftGenView

System.IUnknown
  |
  +---CATIDftGenView
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDftGenView

Interface to retrieve attributs dedicated to generative drawing views.
Role: This interface to retrieve informations dedicated to generative drawing views.


Method Index


o GetBox3D(CATMathPoint*,CATMathPoint*,CATMathPoint*,CATMathPoint*)
Retrieves box mathematical definition.
o GetBox3DOptions(CATDrwGenBox3DType&,CATDrwGenBox3DMode&)
Gets parameters on a box operator.
o GetProjectionPlane(CATMathPlane**)
Returns the projection plane on the Generative View.
o IsBox3DModifiable(CATBoolean*)
Used to know if the Box3D definition comes from an external object (i.
o IsGenerative(boolean*)
Used to know if the view is generative.
o IsShowHidden(boolean*)
Gets the generative view hidden line representation.
o IsShowSmooth(boolean*)
Gets the generative view smooth edges representation.
o RemoveBox3D()
Removes a box3D operator in the view.
o SetBox3D(CATMathPoint*,CATMathPoint*,CATMathPoint*,CATMathPoint*)
Sets or create a clipping box (not available if a DMUBox already exists on the view).
o SetBox3DOptions(CATDrwGenBox3DType,CATDrwGenBox3DMode)
Sets parameters on a box operator.
o SetProjectionPlane(CATMathPlane*)
Sets the projection plane on the Generative View.
o SetShowHidden(boolean)
Sets the generative view hidden line representation.
o SetShowSmooth(boolean)
Sets the generative view smooth edges representation.

Methods


o GetBox3D
public virtual HRESULT GetBox3D(CATMathPoint* oPointA,
CATMathPoint* oPointB,
CATMathPoint* oPointC,
CATMathPoint* oPointD) = 0
Retrieves box mathematical definition.
Parameters:
oBox
The box as xmin, xmax, ymin, ymax, zmin, zmax
o GetBox3DOptions
public virtual HRESULT GetBox3DOptions(CATDrwGenBox3DType& oClippingType,
CATDrwGenBox3DMode& oClippingMode) = 0
Gets parameters on a box operator.
Parameters:
oClippingType
(box, slice or back clipping plane)
oClippingMode
** NOT IMPLEMENTED **
Returns:
S_OK
if operation succeeded.
E_FAIL
if a box does not exist on the view
o GetProjectionPlane
public virtual HRESULT GetProjectionPlane(CATMathPlane** oPlane) const = 0
Returns the projection plane on the Generative View.
Parameters:
oPlane
the CATMathPlane wich describes the projection plane of the view
o IsBox3DModifiable
public virtual HRESULT IsBox3DModifiable(CATBoolean* oBoxModifiable) =0
Used to know if the Box3D definition comes from an external object (i.e. DMUBOX).
Parameters:
oBoxModifiable
TRUE = standalone box FALSE = box created with an external link (i.e. DMUBOX)
o IsGenerative
public virtual HRESULT IsGenerative(boolean* oGenStatus) const = 0
Used to know if the view is generative.
Parameters:
oGenStatus

TRUE = A result is generated from 3D
FALSE = The view isn't generative
o IsShowHidden
public virtual HRESULT IsShowHidden(boolean* oShowHidden) const = 0
Gets the generative view hidden line representation.
Parameters:
oShowHidden

TRUE = Hidden lines are show
FALSE = Hidden lines are not show
o IsShowSmooth
public virtual HRESULT IsShowSmooth(boolean* oShowSmooth) const = 0
Gets the generative view smooth edges representation.
Parameters:
oShowSmooth

TRUE = Smooth edges are show
FALSE = Smooth edges are not show
o RemoveBox3D
public virtual HRESULT RemoveBox3D()=0
Removes a box3D operator in the view.
o SetBox3D
public virtual HRESULT SetBox3D( const CATMathPoint* iPointA,
const CATMathPoint* iPointB,
const CATMathPoint* iPointC,
const CATMathPoint* iPointD) = 0
Sets or create a clipping box (not available if a DMUBox already exists on the view). The view may own only one box
Parameters:
iBox
The box as xmin, xmax, ymin, ymax, zmin, zmax
Returns:
S_OK
if operation succeeded.
E_FAIL
if A DMUBox exists on the view
o SetBox3DOptions
public virtual HRESULT SetBox3DOptions( const CATDrwGenBox3DType iClippingType=ClippingByBox,
const CATDrwGenBox3DMode iClippingMode=Relimit) = 0
Sets parameters on a box operator.
Parameters:
iClippingType
(box, slice or back clipping plane)
iClippingMode
** NOT IMPLEMENTED **
Returns:
S_OK
if operation succeeded.
E_FAIL
if a box does not exist on the view
o SetProjectionPlane
public virtual HRESULT SetProjectionPlane(CATMathPlane* iPlane) = 0
Sets the projection plane on the Generative View.
Parameters:
iPlane
the CATMathPlane wich describes the projection plane of the view
o SetShowHidden
public virtual HRESULT SetShowHidden( const boolean iShowHidden) = 0
Sets the generative view hidden line representation.
Parameters:
iShowHidden

TRUE = Hidden lines are show
FALSE = Hidden lines are not show
o SetShowSmooth
public virtual HRESULT SetShowSmooth( const boolean iShowSmooth) = 0
Sets the generative view smooth edges representation.
Parameters:
iShowSmooth

TRUE = Smooth edges are show
FALSE = Smooth edges are not show

This object is included in the file: CATIDftGenView.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.