Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATDraftingGenUseItf CATDftGenViewProperties

Usage: you must use this class as is. You should never derive it.

public class CATDftGenViewProperties

Class to manage generative view properties.

Constructor and Destructor Index

o CATDftGenViewProperties()
o CATDftGenViewProperties(CATDftGenViewProperties&)
o ~CATDftGenViewProperties()

Method Index

o Get2DLViewGenerationMode(CATBoolean&): Gets generation mode for View From 3D (from 2D Layout View).
o Get3DColorInheritance(CATBoolean&): Gets 3D color inheritance mode.
o Get3DPointExtractionMode(CATBoolean&): Gets 3D point mode.
o Get3DPointsSymbol(int&): Gets 3D point symbol.
o GetApproximateParameters(int*): Gets approximate parameters.
o GetAutoHiddenLinesMode(CATBoolean&): Gets Auto hidden lines mode.
o GetAxisLineExtractionMode(CATBoolean&): Gets axislines mode.
o GetCenterlineExtractionMode(CATBoolean&): Gets centerlines mode.
o GetFilletRep(CATDftFilletRep*): Gets fillet mode.
o GetHiddenLinesMode(CATBoolean&): Gets hidden lines mode.
o GetLimitRepSize(double&): Gets limit Representation size.
o GetOcclusionCullingMode(CATBoolean*): Gets the Occlusion Culling mode.
o GetPatternGenerationMode(CATBoolean&): Gets the Pattern Generation mode for the View.
o GetRasterParameters(int*,RasterLevelOfDetail*,RasterLevelOfDetail*,double*,double*,CATBoolean*): Retrieves the generated raster parameters.
o GetRepresentationMode(CatDftGenRepresentationMode*): Gets 2D representation mode.
o GetScan3DRepsMode(catDftGenRepPolicy*): Gets the scan mode of 3D representations.
o GetSmoothEdgesGenerationMode(CATBoolean&): Gets the Smooth Edges Generation mode for the View.
o GetSpecificPropertiesForViewFrom3D(CATBoolean&,CATBoolean&): Gets specific properties of View From 3D (from TPS View).
o GetThreadExtractionMode(CATBoolean&): Gets threads mode.
o GetWireframeExtractionMode(CATBoolean&,CATBoolean&): Gets wireframe mode.
o Set2DLViewGenerationMode(CATBoolean): Sets generation mode for View From 3D (from 2D Layout View).
o Set3DColorInheritance(CATBoolean): Sets 3D color inheritance mode.
o Set3DPointExtractionMode(CATBoolean): Sets 3D point mode.
o Set3DPointsSymbol(int): Sets 3D point symbol.
o SetApproximateParameters(int): Sets approximate parameters.
o SetAutoHiddenLinesMode(CATBoolean): Sets hidden lines mode.
o SetAxisLineExtractionMode(CATBoolean): Sets axislines mode.
o SetCenterlineExtractionMode(CATBoolean): Sets centerlines mode.
o SetFilletRep(CATDftFilletRep): Sets fillet mode.
o SetHiddenLinesMode(CATBoolean): Sets hidden lines mode.
o SetLimitRepSize(double): Sets limit Representation size.
o SetOcclusionCullingMode(CATBoolean): Sets the Occlusion Culling mode.
o SetPatternGenerationMode(CATBoolean): Sets the Pattern Generation mode for the View.
o SetRasterParameters(int,RasterLevelOfDetail,RasterLevelOfDetail,double,double,CATBoolean): Sets the generated raster parameters.
o SetRepresentationMode(CatDftGenRepresentationMode): Sets 2D representation mode.
o SetScan3DRepsMode(catDftGenRepPolicy): Sets the scan mode of 3D representations.
o SetSmoothEdgesGenerationMode(CATBoolean): Sets the Smooth Edges Generation mode for the View.
o SetSpecificPropertiesForViewFrom3D(CATBoolean,CATBoolean): Sets specific properties of View From 3D (from TPS View).
o SetThreadExtractionMode(CATBoolean): Sets threads mode.
o SetWireframeExtractionMode(CATBoolean,CATBoolean): Sets wireframe mode.

Constructor and Destructor

o CATDftGenViewProperties

public CATDftGenViewProperties(

)

o CATDftGenViewProperties

public CATDftGenViewProperties( )

o ~CATDftGenViewProperties

public virtual ~CATDftGenViewProperties(

)

Methods

o Get2DLViewGenerationMode

public Get2DLViewGenerationMode( oGen2DGeom)

Gets generation mode for View From 3D (from 2D Layout View).
Role: Gets the generation mode for View From 2DL view.

Parameters:

oGen2DGeom: [out] TRUE if the 2D geometry of Layout view has to be extracted.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o Get3DColorInheritance

public Get3DColorInheritance( o3ColorMode)

Gets 3D color inheritance mode.
Role: Gets the 3D color inheritance mode.

Parameters:

o3ColorMode: [out] TRUE if 3D color inheritance.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o Get3DPointExtractionMode

public Get3DPointExtractionMode( o3DPointMode)

Gets 3D point mode.
Role: Gets the 3D point mode.

Parameters:

o3DPointMode: [out] TRUE if 3D points are projected.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o Get3DPointsSymbol

public Get3DPointsSymbol( o3DPointSymbol)

Gets 3D point symbol.
Role: Gets the 3D point symbol applied when generating 2D points.

Parameters:

o3DPointSymbol: [out] Integer corresponding to the point symbol. 0: inheritance from 3D point other: the symbol number

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetApproximateParameters

public GetApproximateParameters( oLevelOfDetail)

Gets approximate parameters.
Role: Gets the approximate level of detail used when computing an approximate view.

Parameters:

oLevelOfDetail: [out] level of detail used when computing an approximate view.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetAutoHiddenLinesMode

public GetAutoHiddenLinesMode( oAutoHiddenMode)

Gets Auto hidden lines mode.
Role: Gets the Auto hidden lines mode.

Parameters:

oAutoHiddenMode: [out] TRUE if hidden lines are visualized in Auto Hidden Mode.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetAxisLineExtractionMode

public GetAxisLineExtractionMode( oAxisLineMode)

Gets axislines mode.
Role: Gets the axislines mode.

Parameters:

oAxisLineMode: [out] TRUE if axislines are generated.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetCenterlineExtractionMode

public GetCenterlineExtractionMode( oCenterlineMode)

Gets centerlines mode.
Role: Gets the centerlines mode.

Parameters:

oCenterlineMode: [out] TRUE if centerlines are generated.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetFilletRep

public GetFilletRep( oFilletRep)

Gets fillet mode.
Role: Gets the fillet representation mode.

Parameters:

oFilletRep: [out] fillet representation mode (NoFillet, BoundaryFillet, FilletOriginalEdge...).

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetHiddenLinesMode

public GetHiddenLinesMode( oHiddenMode)

Gets hidden lines mode.
Role: Gets the hidden lines mode.

Parameters:

oHiddenMode: [out] TRUE if hidden lines are visualized.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetLimitRepSize

public GetLimitRepSize( oLimit)

Gets limit Representation size.
Role: Retrieves the bounding box limits under which a part will not be taken into account during view generation.

Parameters:

oLimit: [out] The limit value 0. means that no part will be filtered.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetOcclusionCullingMode

public GetOcclusionCullingMode( oOcclusionCullingMode)

Gets the Occlusion Culling mode.
Role: Gets the Occlusion Culling mode.

Parameters:

oOcclusionCullingMode: [out] TRUE if Occlusion Culling enables, FALSE if not.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetPatternGenerationMode

public GetPatternGenerationMode( obPatternMode)

Gets the Pattern Generation mode for the View.
Role: Gets the Pattern mode.

Parameters:

obPatternMode: [out] TRUE if Patterns are generated.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetRasterParameters

public GetRasterParameters(	`oMode`,
	`oVisuMode`,
	`oPrintMode`,
	`oVisu`,
	`oPrint`,
	`oLightSourceOn`	`= NULL`)

Retrieves the generated raster parameters.
Role: Retrieves the generated raster parameters, for visualization and print purposes.

Parameters:

oMode: [out] The mode used to generate the raster view.
Accepted values: VIEW_NO_DISPLAY (no image generated), VIEW_HRD, VIEW_MESH or (VIEW_MESH | VIEW_EDGE)
oVisuMode: [out] The precision mode for visualization.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself).
oPrintMode: [out] The precision mode for print purposes.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself).
oVisu: [out] The definition in dpi for visualization (number of pixels per inch in the sheet).
oPrint: [out] The definition in dpi for print purposes.
oLightSourceOn: [out] To get spot light source activation

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetRepresentationMode

public GetRepresentationMode( oRepMode)

Gets 2D representation mode.
Role: Gets the 2D representation mode used when projecting.

Parameters:

oRepMode: [out] Representation mode (catGenExactMode, catGenCGRMode, catGenApproximateMode, catGenRasterMode).

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetScan3DRepsMode

public GetScan3DRepsMode( oRepMode)

Gets the scan mode of 3D representations.
Role: Gets the scan mode of 3D representations.

Parameters:

oRepMode: [out] The parameter role (catDftGenAllDesignRepsPolicy, catDftGenFirstDesignRepsPolicy, ...).

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetSmoothEdgesGenerationMode

public GetSmoothEdgesGenerationMode( obSmoothEdgesMode)

Gets the Smooth Edges Generation mode for the View.
Role: Gets the Smooth Edges mode.

Parameters:

obSmoothEdgesMode: [out] TRUE if SmoothEdges are generated.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetSpecificPropertiesForViewFrom3D

public GetSpecificPropertiesForViewFrom3D(		`oUpdateMode`,
		`oRedCross`)

Gets specific properties of View From 3D (from TPS View).
Role: Gets the specific properties of View From 3D.

Parameters:

oUpdateMode: [out] TRUE if the layout and dress up of annotation extracted from 3d have to be kept.
oRedCross: [out] TRUE if a red cross has to be generated on annotations associated to unrepresented geometry.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the properties are not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetThreadExtractionMode

public GetThreadExtractionMode( oThreadMode)

Gets threads mode.
Role: Gets the threads mode.

Parameters:

oThreadMode: [out] TRUE if threads are generated.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o GetWireframeExtractionMode

public GetWireframeExtractionMode(		`oWireFrameMode`,
		`oAlwaysVisble`)

Gets wireframe mode.
Role: Gets the wireframe mode.

Parameters:

oWireFrameMode: [out] TRUE if wireframe is generated.
oAlwaysVisble: [out] TRUE if wireframe is always visible.

Returns:

S_OK : if the operation succeeded.
S_FALSE : if the property is not valuated.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o Set2DLViewGenerationMode

public Set2DLViewGenerationMode( const iGen2DGeom)

Sets generation mode for View From 3D (from 2D Layout View).
Role: Sets the generation mode for View From 2DL view.

Parameters:

iGen2DGeom: [in] TRUE if the 2D geometry of Layout view has to be extracted.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o Set3DColorInheritance

public Set3DColorInheritance( const i3DColorMode)

Sets 3D color inheritance mode.
Role: Sets the 3D color inheritance mode.

Parameters:

i3DColorMode: [in] TRUE if 3D color inheritance.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o Set3DPointExtractionMode

public Set3DPointExtractionMode( const i3DPointMode)

Sets 3D point mode.
Role: Sets the 3D point mode.

Parameters:

i3DPointMode: [in] TRUE if 3D point must be generated.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o Set3DPointsSymbol

public Set3DPointsSymbol( const i3DPointSymbol)

Sets 3D point symbol.
Role: Sets the 3D point symbol to apply when generating 2D points.

Parameters:

i3DPointSymbol: [in] Integer corresponding to the point symbol.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetApproximateParameters

public SetApproximateParameters( const iLevelOfDetail)

Sets approximate parameters.
Role: Sets the approximate level of detail used when computing an approximate view.

Parameters:

iLevelOfDetail: [in] level of detail used when computing an approximate view.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetAutoHiddenLinesMode

public SetAutoHiddenLinesMode( const iAutoHiddenMode)

Sets hidden lines mode.
Role: Sets the Auto hidden lines mode.

Parameters:

iAutoHiddenMode: [in] TRUE if hidden lines are visualized in Auto Hidden Mode.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetAxisLineExtractionMode

public SetAxisLineExtractionMode( const iAxisLineMode)

Sets axislines mode.
Role: Sets the axislines mode.

Parameters:

iAxisLineMode: [in] TRUE if axislines must be generated.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetCenterlineExtractionMode

public SetCenterlineExtractionMode( const iCenterlineMode)

Sets centerlines mode.
Role: Sets the centerlines mode.

Parameters:

iCenterlineMode: [in] TRUE if centerlines must be generated.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetFilletRep

public SetFilletRep( const iFilletRep)

Sets fillet mode.
Role: Sets the fillet representation mode.

Parameters:

iFilletRep: [in] fillet representation mode (NoFillet, BoundaryFillet, FilletOriginalEdge...).

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetHiddenLinesMode

public SetHiddenLinesMode( const iHiddenMode)

Sets hidden lines mode.
Role: Sets the hidden lines mode.

Parameters:

iHiddenMode: [in] TRUE if hidden lines are visualized.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetLimitRepSize

public SetLimitRepSize( const iLimit)

Sets limit Representation size.
Role: Sets the bounding box limits under which a part will not be taken into account during view generation.

Parameters:

iLimit: [in] The limit value. Set it to 0. to disable this filter.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetOcclusionCullingMode

public SetOcclusionCullingMode( const iOcclusionCullingMode)

Sets the Occlusion Culling mode.
Role: Sets the Occlusion Culling mode for generating views. Occlusion Culling uses the graphic card to improve performance during view generation, by avoiding the loading of hidden bodies.

Parameters:

iOcclusionCullingMode: [in] TRUE to enable Occlusion Culling, FALSE if not.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetPatternGenerationMode

public SetPatternGenerationMode( const ibPatternMode)

Sets the Pattern Generation mode for the View.
Role: Sets the Pattern mode.

Parameters:

ibPatternMode: [in] TRUE if Pattern is to be generated.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetRasterParameters

public SetRasterParameters(	const	`iMode`,
	const	`iVisuMode`,
	const	`iPrintMode`,
	const	`iVisu`,
	const	`iPrint`,
		`iLightSourceOn`	`= TRUE`)

Sets the generated raster parameters.
Role: Sets the generated raster parameters, for visualization and print purposes.

Parameters:

iMode: [in] The mode used to generate the raster view.
Accepted values: VIEW_NO_DISPLAY (no image generated), VIEW_HRD, VIEW_MESH or (VIEW_MESH | VIEW_EDGE)
iVisuMode: [in] The precision mode for visualization.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself).
iPrintMode: [in] The precision mode for print purposes.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself).
iVisu: The definition in dpi for visualization (number of pixels per inch in the sheet).
iPrint: [in] The definition in dpi for print purposes.
iLightSourceOn: [in] To set spot light source activation (default value activated)

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetRepresentationMode

public SetRepresentationMode( const iRepMode)

Sets 2D representation mode.
Role: Sets the 2D representation mode used when projecting.

Parameters:

iRepMode: [in] Representation mode (catGenExactMode, catGenCGRMode, catGenApproximateMode, catGenRasterMode).

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetScan3DRepsMode

public SetScan3DRepsMode( const iRepMode)

Sets the scan mode of 3D representations.
Role: Sets the scan mode of 3D representations.

Parameters:

iRepMode: [in] The parameter role (catDftGenAllDesignRepsPolicy, catDftGenFirstDesignRepsPolicy, ...).

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetSmoothEdgesGenerationMode

public SetSmoothEdgesGenerationMode( const ibSmoothEdgesMode)

Sets the Smooth Edges Generation mode for the View.
Role: Sets the Smooth Edges mode.

Parameters:

ibSmoothEdgesMode: [in] TRUE if Smooth Edges are to be generated.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetSpecificPropertiesForViewFrom3D

public SetSpecificPropertiesForViewFrom3D(	const	`iUpdateMode`,
	const	`iRedCross`)

Sets specific properties of View From 3D (from TPS View).
Role: Sets the specific properties of View From 3D.

Parameters:

iUpdateMode: [in] TRUE if the layout and dress up of annotation extracted from 3d have to be kept.
iRedCross: [in] TRUE if a red cross has to be generated on annotations associated to unrepresented geometry.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetThreadExtractionMode

public SetThreadExtractionMode( const iThreadMode)

Sets threads mode.
Role: Sets the threads mode.

Parameters:

iThreadMode: [in] TRUE if threads must be generated.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

o SetWireframeExtractionMode

public SetWireframeExtractionMode(	const	`iWireFrameMode`,
		`iAlwaysVisible`	`= FALSE`)

Sets wireframe mode.
Role: Sets the wireframe mode.

Parameters:

iAxisLineMode: [in] TRUE if wireframe must be generated.
iAlwaysVisible: [in] FALSE if wireframe can be hidden.

Returns:

S_OK : if the operation succeeded.
E_INVALIDARG : if the arguments are incorrect.
E_FAIL : if the operation failed.

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

CATDraftingGenUseItf writeClassCharacteristic(); CATDftGenViewProperties

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

CATDraftingGenUseItf CATDftGenViewProperties