OCC.Core.Aspect module

Aspect module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_aspect.html

class Aspect_Background(*args)

Bases: object

• Creates a window background. Default colorNOC_MATRAGRAY.

  rtype

  None* Creates a window background with the colour <AColor>.

  param AColor

  type AColor

  Quantity_Color

  rtype

  None

Color()

• Returns the colour of the window background <self>.

  rtype

  Quantity_Color

SetColor()

• Modifies the colour of the window background <self>.

  param AColor

  type AColor

  Quantity_Color

  rtype

  None

property thisown

The membership flag

class Aspect_DisplayConnection

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

property thisown

The membership flag

class Aspect_GenId(*args)

Bases: object

• Creates an available set of identifiers with the lower bound 0 and the upper bound INT_MAX / 2.

  rtype

  None* Creates an available set of identifiers with specified range. Raises IdentDefinitionError if theUpper is less than theLow.

  param theLow

  type theLow

  int

  param theUpper

  type theUpper

  int

  rtype

  None

Available()

• Returns the number of available identifiers.

  rtype

  int

Free()

• Free all identifiers - make the whole range available again.

  rtype

  None* Free specified identifier. Warning - method has no protection against double-freeing!

  param theId

  type theId

  int

  rtype

  None

HasFree()

• Returns true if there are available identifiers in range.

  rtype

  bool

Lower()

• Returns the lower identifier in range.

  rtype

  int

Next()

• Returns the next available identifier. Warning: Raises IdentDefinitionError if all identifiers are busy.

  rtype

  int* Generates the next available identifier. @param theId [out] generated identifier returns False if all identifiers are busy.

  param theId

  type theId

  int

  rtype

  bool

Upper()

• Returns the upper identifier in range.

  rtype

  int

property thisown

The membership flag

class Aspect_GradientBackground(*args)

Bases: OCC.Core.Aspect.Aspect_Background

• Creates a window gradient background. Default colorsQuantity_NOC_BLACK. Default fill methodAspect_GFM_NONE

  rtype

  None* Creates a window gradient background with colours <AColor1, AColor2>.

  param AColor1

  type AColor1

  Quantity_Color

  param AColor2

  type AColor2

  Quantity_Color

  param AMethod

  default value is Aspect_GFM_HOR

  type AMethod

  Aspect_GradientFillMethod

  rtype

  None

BgGradientFillMethod()

• Returns the current gradient background fill mode.

  rtype

  Aspect_GradientFillMethod

Colors()

• Returns colours of the window gradient background <self>.

  param AColor1

  type AColor1

  Quantity_Color

  param AColor2

  type AColor2

  Quantity_Color

  rtype

  None

SetColors()

• Modifies the colours of the window gradient background <self>.

  param AColor1

  type AColor1

  Quantity_Color

  param AColor2

  type AColor2

  Quantity_Color

  param AMethod

  default value is Aspect_GFM_HOR

  type AMethod

  Aspect_GradientFillMethod

  rtype

  None

property thisown

The membership flag

class Aspect_Grid(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Activate()

• activates the grid. The Hit method will return gridx and gridx computed according to the steps of the grid.

  rtype

  None

Colors()

• Returns the colors of the grid.

  param aColor

  type aColor

  Quantity_Color

  param aTenthColor

  type aTenthColor

  Quantity_Color

  rtype

  None

Compute()

• returns the point of the grid the closest to the point X,Y

  param X

  type X

  float

  param Y

  type Y

  float

  param gridX

  type gridX

  float

  param gridY

  type gridY

  float

  rtype

  void

Deactivate()

• deactivates the grid. The hit method will return gridx and gridx as the enter value X & Y.

  rtype

  None

Display()

• Display the grid at screen.

  rtype

  void

static DownCast(t)

DrawMode()

• Returns the grid aspect.

  rtype

  Aspect_GridDrawMode

Erase()

• Erase the grid from screen.

  rtype

  void

Hit()

• returns the point of the grid the closest to the point X,Y if the grid is active. If the grid is not active returns X,Y.

  param X

  type X

  float

  param Y

  type Y

  float

  param gridX

  type gridX

  float

  param gridY

  type gridY

  float

  rtype

  None

Init()

Return type

void

IsActive()

• Returns True when the grid is active.

  rtype

  bool

IsDisplayed()

• Returns True when the grid is displayed at screen.

  rtype

  bool

Rotate()

• Rotate the grid from a relative angle.

  param anAngle

  type anAngle

  float

  rtype

  None

RotationAngle()

• returns the x Angle of the grid.

  rtype

  float

SetColors()

• Change the colors of the grid

  param aColor

  type aColor

  Quantity_Color

  param aTenthColor

  type aTenthColor

  Quantity_Color

  rtype

  void

SetDrawMode()

• Change the grid aspect.

  param aDrawMode

  type aDrawMode

  Aspect_GridDrawMode

  rtype

  None

SetRotationAngle()

• defines the orientation of the grid.

  param anAngle

  type anAngle

  float

  rtype

  None

SetXOrigin()

• defines the x Origin of the grid.

  param anOrigin

  type anOrigin

  float

  rtype

  None

SetYOrigin()

• defines the y Origin of the grid.

  param anOrigin

  type anOrigin

  float

  rtype

  None

Translate()

• Translate the grid from a relative distance.

  param aDx

  type aDx

  float

  param aDy

  type aDy

  float

  rtype

  None

XOrigin()

• returns the x Origin of the grid.

  rtype

  float

YOrigin()

• returns the x Origin of the grid.

  rtype

  float

property thisown

The membership flag

class Aspect_ScrollDelta(*args)

Bases: object

• Empty constructor.

  rtype

  None* Constructor.

  param thePnt

  type thePnt

  NCollection_Vec2<int>

  param theValue

  type theValue

  float

  param theFlags

  default value is Aspect_VKeyFlags_NONE

  type theFlags

  Aspect_VKeyFlags

  rtype

  None* Constructor with undefined point.

  param theValue

  type theValue

  float

  param theFlags

  default value is Aspect_VKeyFlags_NONE

  type theFlags

  Aspect_VKeyFlags

  rtype

  None

property Delta

property Flags

HasPoint()

• //!< key flags Return true if action has point defined.

  rtype

  bool

ResetPoint()

• Reset at point.

  rtype

  None

property thisown

The membership flag

class Aspect_SequenceOfColor(*args)

Bases: object

Append()

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

Clear()

Exchange()

First()

InsertAfter()

InsertBefore()

IsEmpty()

Last()

Length()

Lower()

Prepend()

Remove()

Reverse()

Set()

SetValue()

Size()

Split()

Upper()

Value()

begin()

cbegin()

cend()

static delNode()

end()

property thisown

The membership flag

class Aspect_Touch(*args)

Bases: object

• Empty constructor

  rtype

  None* Constructor with initialization.

  param thePnt

  type thePnt

  NCollection_Vec2<float>

  param theIsPreciseDevice

  type theIsPreciseDevice

  bool

  rtype

  None* Constructor with initialization.

  param theX

  type theX

  float

  param theY

  type theY

  float

  param theIsPreciseDevice

  type theIsPreciseDevice

  bool

  rtype

  None

Delta()

• //!< precise device input (e.g. mouse cursor, NOT emulated from touch screen) Return values delta.

  rtype

  NCollection_Vec2<float>

property IsPreciseDevice

property thisown

The membership flag

class Aspect_TouchMap(*args)

Bases: object

Add()

Assign()

ChangeFromIndex()

ChangeFromKey()

ChangeSeek()

Clear()

Contains()

Exchange()

FindFromIndex()

FindFromKey()

FindIndex()

FindKey()

ReSize()

RemoveFromIndex()

RemoveKey()

RemoveLast()

Seek()

Set()

Size()

Substitute()

Swap()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class Aspect_Window(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Background()

• Returns the window background.

  rtype

  Aspect_Background

BackgroundFillMethod()

• Returns the current image background fill mode.

  rtype

  Aspect_FillMethod

DoMapping()

• Apply the mapping change to the window <self>. and returns True if the window is mapped at screen.

  rtype

  bool

DoResize()

• Apply the resizing to the window <self>.

  rtype

  Aspect_TypeOfResize

static DownCast(t)

GradientBackground()

• Returns the window gradient background.

  rtype

  Aspect_GradientBackground

InvalidateContent()

• Invalidate entire window content. //! Implementation is expected to allow calling this method from non-GUI thread, e.g. by queuing exposure event into window message queue or in other thread-safe manner. //! Optional display argument should be passed when called from non-GUI thread on platforms implementing thread-unsafe connections to display. NULL can be passed instead otherwise.

  param theDisp

  type theDisp

  Aspect_DisplayConnection

  rtype

  None

IsMapped()

• Returns True if the window <self> is opened and False if the window is closed.

  rtype

  bool

IsVirtual()

• Returns True if the window <self> is virtual

  rtype

  bool

Map()

• Opens the window <self>.

  rtype

  void

NativeFBConfig()

• Returns native Window FB config (GLXFBConfig on Xlib)

  rtype

  Aspect_FBConfig

Position()

• Returns The Window POSITION in PIXEL

  param X1

  type X1

  int

  param Y1

  type Y1

  int

  param X2

  type X2

  int

  param Y2

  type Y2

  int

  rtype

  void

Ratio()

• Returns The Window RATIO equal to the physical WIDTH/HEIGHT dimensions

  rtype

  float

SetBackground()

• Modifies the window background.

  param ABack

  type ABack

  Aspect_Background

  rtype

  None* Modifies the window background.

  param color

  type color

  Quantity_Color

  rtype

  None* Modifies the window gradient background.

  param ABackground

  type ABackground

  Aspect_GradientBackground

  rtype

  None* Modifies the window gradient background.

  param theFirstColor

  type theFirstColor

  Quantity_Color

  param theSecondColor

  type theSecondColor

  Quantity_Color

  param theFillMethod

  type theFillMethod

  Aspect_GradientFillMethod

  rtype

  None

SetTitle()

• Sets window title.

  param theTitle

  type theTitle

  TCollection_AsciiString

  rtype

  None

SetVirtual()

• Setup the virtual state

  param theVirtual

  type theVirtual

  bool

  rtype

  None

Size()

• Returns The Window SIZE in PIXEL

  param Width

  type Width

  int

  param Height

  type Height

  int

  rtype

  void

Unmap()

• Closes the window <self>.

  rtype

  void

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()