OCC.XCAFPrs module¶

Presentation (visualiation, selection etc.) tools forDECAF documents

class Handle_XCAFPrs_AISObject(*args)¶

Bases: OCC.AIS.Handle_AIS_ColoredShape

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_XCAFPrs_DataMapNodeOfDataMapOfShapeStyle(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_XCAFPrs_DataMapNodeOfDataMapOfStyleShape(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_XCAFPrs_DataMapNodeOfDataMapOfStyleTransient(*args)¶

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class Handle_XCAFPrs_Driver(*args)¶

Bases: OCC.TPrsStd.Handle_TPrsStd_Driver

static DownCast()¶

GetObject()¶

IsNull()¶

Nullify()¶

thisown¶: The membership flag

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

thisown¶: The membership flag

value()¶

class XCAFPrs_AISObject(*args)¶

Bases: OCC.AIS.AIS_ColoredShape

Creates an object to visualise the shape label.

Parameters:	theLabel (TDF_Label &) –
Return type:	None

GetHandle()¶

thisown¶: The membership flag

class XCAFPrs_DataMapIteratorOfDataMapOfShapeStyle(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (XCAFPrs_DataMapOfShapeStyle &) –
Return type:	None

Initialize()¶

Parameters:	aMap (XCAFPrs_DataMapOfShapeStyle &) –
Return type:	None

Key()¶

Return type:	TopoDS_Shape

Value()¶

Return type:	XCAFPrs_Style

thisown¶: The membership flag

class XCAFPrs_DataMapIteratorOfDataMapOfStyleShape(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (XCAFPrs_DataMapOfStyleShape &) –
Return type:	None

Initialize()¶

Parameters:	aMap (XCAFPrs_DataMapOfStyleShape &) –
Return type:	None

Key()¶

Return type:	XCAFPrs_Style

Value()¶

Return type:	TopoDS_Shape

thisown¶: The membership flag

class XCAFPrs_DataMapIteratorOfDataMapOfStyleTransient(*args)¶

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:	None
Parameters:	aMap (XCAFPrs_DataMapOfStyleTransient &) –
Return type:	None

Initialize()¶

Parameters:	aMap (XCAFPrs_DataMapOfStyleTransient &) –
Return type:	None

Key()¶

Return type:	XCAFPrs_Style

Value()¶

Return type:	Handle_Standard_Transient

thisown¶: The membership flag

class XCAFPrs_DataMapNodeOfDataMapOfShapeStyle(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K (TopoDS_Shape &) – I (XCAFPrs_Style &) – n (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

Key()¶

Return type:	TopoDS_Shape

Value()¶

Return type:	XCAFPrs_Style

thisown¶: The membership flag

class XCAFPrs_DataMapNodeOfDataMapOfStyleShape(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K (XCAFPrs_Style &) – I (TopoDS_Shape &) – n (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

Key()¶

Return type:	XCAFPrs_Style

Value()¶

Return type:	TopoDS_Shape

thisown¶: The membership flag

class XCAFPrs_DataMapNodeOfDataMapOfStyleTransient(*args)¶

Bases: OCC.TCollection.TCollection_MapNode

Parameters:	K (XCAFPrs_Style &) – I (Handle_Standard_Transient &) – n (TCollection_MapNodePtr &) –
Return type:	None

GetHandle()¶

Key()¶

Return type:	XCAFPrs_Style

Value()¶

Return type:	Handle_Standard_Transient

thisown¶: The membership flag

class XCAFPrs_DataMapOfShapeStyle(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Assign()¶

Parameters:	Other (XCAFPrs_DataMapOfShapeStyle &) –
Return type:	XCAFPrs_DataMapOfShapeStyle

Bind()¶

Parameters:	K (TopoDS_Shape &) – I (XCAFPrs_Style &) –
Return type:	bool

ChangeFind()¶

Parameters:	K (TopoDS_Shape &) –
Return type:	XCAFPrs_Style

ChangeFind1()¶

Parameters:	K (TopoDS_Shape &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Find()¶

Parameters:	K (TopoDS_Shape &) –
Return type:	XCAFPrs_Style

Find1()¶

Parameters:	K (TopoDS_Shape &) –
Return type:	Standard_Address

IsBound()¶

Parameters:	K (TopoDS_Shape &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (XCAFPrs_DataMapOfShapeStyle &) –
Return type:	XCAFPrs_DataMapOfShapeStyle

UnBind()¶

Parameters:	K (TopoDS_Shape &) –
Return type:	bool

thisown¶: The membership flag

class XCAFPrs_DataMapOfStyleShape(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Assign()¶

Parameters:	Other (XCAFPrs_DataMapOfStyleShape &) –
Return type:	XCAFPrs_DataMapOfStyleShape

Bind()¶

Parameters:	K (XCAFPrs_Style &) – I (TopoDS_Shape &) –
Return type:	bool

ChangeFind()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	TopoDS_Shape

ChangeFind1()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Find()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	TopoDS_Shape

Find1()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	Standard_Address

IsBound()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (XCAFPrs_DataMapOfStyleShape &) –
Return type:	XCAFPrs_DataMapOfStyleShape

UnBind()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	bool

thisown¶: The membership flag

class XCAFPrs_DataMapOfStyleTransient(*args)¶

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:	NbBuckets (int) – default value is 1
Return type:	None

Assign()¶

Parameters:	Other (XCAFPrs_DataMapOfStyleTransient &) –
Return type:	XCAFPrs_DataMapOfStyleTransient

Bind()¶

Parameters:	K (XCAFPrs_Style &) – I (Handle_Standard_Transient &) –
Return type:	bool

ChangeFind()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	Handle_Standard_Transient

ChangeFind1()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	Standard_Address

Clear()¶

Return type:	None

Find()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	Handle_Standard_Transient

Find1()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	Standard_Address

IsBound()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	bool

ReSize()¶

Parameters:	NbBuckets (int) –
Return type:	None

Set()¶

Parameters:	Other (XCAFPrs_DataMapOfStyleTransient &) –
Return type:	XCAFPrs_DataMapOfStyleTransient

UnBind()¶

Parameters:	K (XCAFPrs_Style &) –
Return type:	bool

thisown¶: The membership flag

class XCAFPrs_Driver(*args, **kwargs)¶

Bases: OCC.TPrsStd.TPrsStd_Driver

GetHandle()¶

static GetID()¶

returns GUID of the driver

Return type:	Standard_GUID

thisown¶: The membership flag

XCAFPrs_Driver_GetID()¶

returns GUID of the driver

Return type:	Standard_GUID

class XCAFPrs_Style(*args)¶

Bases: object

Return type:	None

GetColorCurv()¶

Return type:	Quantity_Color

GetColorSurf()¶

Return type:	Quantity_Color

static HashCode()¶

Returns a HasCode value for the Key <K> in the range 0..Upper.

Parameters:	S (XCAFPrs_Style &) – Upper (int) –
Return type:	int

static IsEqual()¶

Returs True if styles are the same Methods for using Style as key in maps

Parameters:	other (XCAFPrs_Style &) –
Return type:	bool

Returns True when the two keys are the same. Two same keys must have the same hashcode, the contrary is not necessary.

Parameters:	S1 (XCAFPrs_Style &) – S2 (XCAFPrs_Style &) –
Return type:	bool

IsSetColorCurv()¶

Return type:	bool

IsSetColorSurf()¶

Return type:	bool

IsVisible()¶

Manage visibility Note: Setting visibility to False makes colors undefined This is necessary for HashCode

Return type:	bool

SetColorCurv()¶

Parameters:	col (Quantity_Color &) –
Return type:	None

SetColorSurf()¶

Parameters:	col (Quantity_Color &) –
Return type:	None

SetVisibility()¶

Parameters:	visibility (bool) –
Return type:	None

UnSetColorCurv()¶

Manage curve color setting

Return type:	None

UnSetColorSurf()¶

Manage surface color setting

Return type:	None

thisown¶: The membership flag

XCAFPrs_Style_HashCode()¶

Returns a HasCode value for the Key <K> in the range 0..Upper.

Parameters:	S (XCAFPrs_Style &) – Upper (int) –
Return type:	int

XCAFPrs_Style_IsEqual()¶

Returs True if styles are the same Methods for using Style as key in maps

Parameters:	other (XCAFPrs_Style &) –
Return type:	bool

Returns True when the two keys are the same. Two same keys must have the same hashcode, the contrary is not necessary.

Parameters:	S1 (XCAFPrs_Style &) – S2 (XCAFPrs_Style &) –
Return type:	bool

new_instancemethod(func, inst, cls)¶

register_handle(handle, base_object)¶: Inserts the handle into the base object to prevent memory corruption in certain cases

class xcafprs¶

Bases: object

static CollectStyleSettings()¶

Collect styles defined for shape on label L and its components and subshapes and fills a map of shape - style correspondence The location <loc> is for internal use, it should be Null location for external call

Parameters:	L (TDF_Label &) – loc (TopLoc_Location &) – settings (XCAFPrs_DataMapOfShapeStyle &) –
Return type:	void

static GetViewNameMode()¶

Return type:	bool

static SetViewNameMode()¶

Set ViewNameMode for indicate display names or not.

Parameters:	viewNameMode (bool) –
Return type:	void

thisown¶: The membership flag

xcafprs_CollectStyleSettings()¶

Collect styles defined for shape on label L and its components and subshapes and fills a map of shape - style correspondence The location <loc> is for internal use, it should be Null location for external call

Parameters:	L (TDF_Label &) – loc (TopLoc_Location &) – settings (XCAFPrs_DataMapOfShapeStyle &) –
Return type:	void

xcafprs_GetViewNameMode()¶

Return type:	bool

xcafprs_SetViewNameMode()¶

Set ViewNameMode for indicate display names or not.

Parameters:	viewNameMode (bool) –
Return type:	void