OCC.Materials module

class OCC.Materials.Handle_Materials_Color(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class OCC.Materials.Handle_Materials_FuzzyInstance(*args)

Bases: OCC.Dynamic.Handle_Dynamic_FuzzyClass

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class OCC.Materials.Handle_Materials_Material(*args)

Bases: OCC.Materials.Handle_Materials_FuzzyInstance

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class OCC.Materials.Handle_Materials_MaterialDefinition(*args)

Bases: OCC.Dynamic.Handle_Dynamic_FuzzyDefinitionsDictionary

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class OCC.Materials.Handle_Materials_MaterialsDictionary(*args)

Bases: OCC.Standard.Handle_Standard_Transient

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class OCC.Materials.Handle_Materials_MaterialsSequence(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class OCC.Materials.Handle_Materials_SequenceNodeOfMtsSequence(*args)

Bases: OCC.TCollection.Handle_TCollection_SeqNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class OCC.Materials.Materials_Color(*args)

Bases: OCC.Standard.Standard_Transient

Color()
  • Sets <acolor> into <self>.
Parameters:acolor (Quantity_Color &) –
Return type:None
  • Returns a Quantity_Color corresponding to <self>.
Return type:Quantity_Color
  • Get the values ( RGB or HLS ) between 0.0 and 1.0
Parameters:
  • aTypeOfColor (Quantity_TypeOfColor) –
  • Reel1 (float &) –
  • Reel2 (float &) –
  • Reel3 (float &) –
Return type:

None

Color255()
  • Get the values ( RGB or HLS ) between 0.0 and 255.0
Parameters:
  • aTypeOfColor (Quantity_TypeOfColor) –
  • Reel1 (float &) –
  • Reel2 (float &) –
  • Reel3 (float &) –
Return type:

None

GetHandle()

Materials_Color_GetHandle(Materials_Color self) -> Handle_Materials_Color

SetColor()
  • Set the values ( RGB or HLS ) between 0.0 and 1.0
Parameters:
  • aTypeOfColor (Quantity_TypeOfColor) –
  • Reel1 (float) –
  • Reel2 (float) –
  • Reel3 (float) –
Return type:

None

SetColor255()
  • Set the values ( RGB or HLS ) between 0.0 and 255.0
Parameters:
  • aTypeOfColor (Quantity_TypeOfColor) –
  • Reel1 (float) –
  • Reel2 (float) –
  • Reel3 (float) –
Return type:

None

thisown

The membership flag

class OCC.Materials.Materials_FuzzyInstance(*args)

Bases: OCC.Dynamic.Dynamic_FuzzyClass

Definition()
Return type:Handle_Dynamic_FuzzyClass
DumpToString()

Materials_FuzzyInstance_DumpToString(Materials_FuzzyInstance self) -> std::string

GetHandle()

Materials_FuzzyInstance_GetHandle(Materials_FuzzyInstance self) -> Handle_Materials_FuzzyInstance

Parameter()
Parameters:
  • aparameter (char *) –
  • avalue (float) –
  • aparameter
  • avalue
  • aparameter
  • avalue
  • aparameter
  • astring (char *) –
  • aparameter
  • anobject (Handle_Standard_Transient &) –
Return type:

void

Return type:

void

Return type:

void

Return type:

void

Return type:

void

Value()
Parameters:
  • aparameter (char *) –
  • avalue (Handle_Standard_Transient &) –
  • aparameter
  • avalue
  • aparameter
  • avalue
  • aparameter
  • avalue
  • aparameter
  • avalue
Return type:

bool

Return type:

bool

Return type:

bool

Return type:

bool

Return type:

bool

thisown

The membership flag

class OCC.Materials.Materials_Material(*args)

Bases: OCC.Materials.Materials_FuzzyInstance

DumpToString()

Materials_Material_DumpToString(Materials_Material self) -> std::string

GetHandle()

Materials_Material_GetHandle(Materials_Material self) -> Handle_Materials_Material

Name()
  • Returns the name of the material.
Return type:TCollection_AsciiString
thisown

The membership flag

class OCC.Materials.Materials_MaterialDefinition

Bases: OCC.Dynamic.Dynamic_FuzzyDefinitionsDictionary

GetHandle()

Materials_MaterialDefinition_GetHandle(Materials_MaterialDefinition self) -> Handle_Materials_MaterialDefinition

thisown

The membership flag

class OCC.Materials.Materials_MaterialsDictionary

Bases: OCC.Standard.Standard_Transient

DumpToString()

Materials_MaterialsDictionary_DumpToString(Materials_MaterialsDictionary self) -> std::string

ExistMaterial()
  • True if the materialofname aName exists ...
Parameters:aName (char *) –
Return type:bool
GetHandle()

Materials_MaterialsDictionary_GetHandle(Materials_MaterialsDictionary self) -> Handle_Materials_MaterialsDictionary

Material()
  • Retrieves from the dictionary the object material with <amaterial> as name. If <amaterial> does not exist in the dictionary an exeption is raised.
Parameters:amaterial (char *) –
Return type:Handle_Materials_Material
  • This method used with the previous one, allow the exploration of all the dictionary. It returns a Material instance.
Parameters:anindex (Standard_Integer) –
Return type:Handle_Materials_Material
NumberOfMaterials()
  • Returns the number of materials previously stored in the dictionary.
Return type:int
UpToDate()
  • Returns true if there has been no modification of the file Materials.dat since the creation of the dictionary object, false otherwise.
Return type:bool
thisown

The membership flag

class OCC.Materials.Materials_MaterialsSequence

Bases: OCC.MMgt.MMgt_TShared

Append()
Parameters:
  • anItem (Handle_Materials_Material &) –
  • aSequence (Handle_Materials_MaterialsSequence &) –
Return type:

None

Return type:

None

ChangeSequence()
Return type:Materials_MtsSequence
ChangeValue()
Parameters:anIndex (Standard_Integer) –
Return type:Handle_Materials_Material
Clear()
Return type:None
Exchange()
Parameters:
  • anIndex (Standard_Integer) –
  • anOtherIndex (Standard_Integer) –
Return type:

None

GetHandle()

Materials_MaterialsSequence_GetHandle(Materials_MaterialsSequence self) -> Handle_Materials_MaterialsSequence

InsertAfter()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Handle_Materials_Material &) –
  • anIndex
  • aSequence (Handle_Materials_MaterialsSequence &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Handle_Materials_Material &) –
  • anIndex
  • aSequence (Handle_Materials_MaterialsSequence &) –
Return type:

None

Return type:

None

IsEmpty()
Return type:bool
Length()
Return type:int
Prepend()
Parameters:
  • anItem (Handle_Materials_Material &) –
  • aSequence (Handle_Materials_MaterialsSequence &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • anIndex (Standard_Integer) –
  • fromIndex (Standard_Integer) –
  • toIndex (Standard_Integer) –
Return type:

None

Return type:

None

Reverse()
Return type:None
Sequence()
Return type:Materials_MtsSequence
SetValue()
Parameters:
  • anIndex (Standard_Integer) –
  • anItem (Handle_Materials_Material &) –
Return type:

None

ShallowCopy()
Return type:Handle_Materials_MaterialsSequence
Split()
Parameters:anIndex (Standard_Integer) –
Return type:Handle_Materials_MaterialsSequence
Value()
Parameters:anIndex (Standard_Integer) –
Return type:Handle_Materials_Material
thisown

The membership flag

class OCC.Materials.Materials_MtsSequence

Bases: OCC.TCollection.TCollection_BaseSequence

Append()
Parameters:
  • T (Handle_Materials_Material &) –
  • S (Materials_MtsSequence &) –
Return type:

None

Return type:

None

Assign()
Parameters:Other (Materials_MtsSequence &) –
Return type:Materials_MtsSequence
ChangeValue()
Parameters:Index (Standard_Integer) –
Return type:Handle_Materials_Material
Clear()
Return type:None
First()
Return type:Handle_Materials_Material
InsertAfter()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_Materials_Material &) –
  • Index
  • S (Materials_MtsSequence &) –
Return type:

None

Return type:

None

InsertBefore()
Parameters:
  • Index (Standard_Integer) –
  • T (Handle_Materials_Material &) –
  • Index
  • S (Materials_MtsSequence &) –
Return type:

None

Return type:

None

Last()
Return type:Handle_Materials_Material
Prepend()
Parameters:
  • T (Handle_Materials_Material &) –
  • S (Materials_MtsSequence &) –
Return type:

None

Return type:

None

Remove()
Parameters:
  • Index (Standard_Integer) –
  • FromIndex (Standard_Integer) –
  • ToIndex (Standard_Integer) –
Return type:

None

Return type:

None

Set()
Parameters:Other (Materials_MtsSequence &) –
Return type:Materials_MtsSequence
SetValue()
Parameters:
  • Index (Standard_Integer) –
  • I (Handle_Materials_Material &) –
Return type:

None

Split()
Parameters:
  • Index (Standard_Integer) –
  • Sub (Materials_MtsSequence &) –
Return type:

None

Value()
Parameters:Index (Standard_Integer) –
Return type:Handle_Materials_Material
thisown

The membership flag

class OCC.Materials.Materials_SequenceNodeOfMtsSequence(*args)

Bases: OCC.TCollection.TCollection_SeqNode

GetHandle()

Materials_SequenceNodeOfMtsSequence_GetHandle(Materials_SequenceNodeOfMtsSequence self) -> Handle_Materials_SequenceNodeOfMtsSequence

Value()
Return type:Handle_Materials_Material
thisown

The membership flag

class OCC.Materials.SwigPyIterator(*args, **kwargs)

Bases: object

advance()
copy()
decr()
distance()
equal()
incr()
next()
previous()
thisown

The membership flag

value()
class OCC.Materials.materials(*args, **kwargs)

Bases: object

static DictionaryOfMaterials()
  • Returns the dictionary of materials.The dictionary is created at the first call to this method, or if the dictionary is not up to date with respect to the file date.
Return type:Handle_Materials_MaterialsDictionary
static ExistMaterial(*args)
  • True if the materialofname aName exists ...
Parameters:aName (char *) –
Return type:bool
static Material(*args)
  • Retrieves from the dictionary the object material with <amaterial> as name.
Parameters:amaterial (char *) –
Return type:Handle_Materials_Material
  • This method used with the previous one, allows the exploration of all the dictionary. It returns a Material instance.
Parameters:anindex (Standard_Integer) –
Return type:Handle_Materials_Material
static MaterialFile(*args)
  • Sets the location and the name of the file defining the definition of a material, in term of properties.
Parameters:afile (char *) –
Return type:void
static MaterialsFile(*args)
  • Sets the location and the name of the file defining the dictionary of materials.
Parameters:afile (char *) –
Return type:void
  • Returns the location and the name of the dictionary file of materials.
Return type:char *
static NumberOfMaterials()
  • Returns the number of materials previously stored in the dictionary.
Return type:int
thisown

The membership flag

OCC.Materials.materials_DictionaryOfMaterials()
  • Returns the dictionary of materials.The dictionary is created at the first call to this method, or if the dictionary is not up to date with respect to the file date.
Return type:Handle_Materials_MaterialsDictionary
OCC.Materials.materials_ExistMaterial(*args)
  • True if the materialofname aName exists ...
Parameters:aName (char *) –
Return type:bool
OCC.Materials.materials_Material(*args)
  • Retrieves from the dictionary the object material with <amaterial> as name.
Parameters:amaterial (char *) –
Return type:Handle_Materials_Material
  • This method used with the previous one, allows the exploration of all the dictionary. It returns a Material instance.
Parameters:anindex (Standard_Integer) –
Return type:Handle_Materials_Material
OCC.Materials.materials_MaterialFile(*args)
  • Sets the location and the name of the file defining the definition of a material, in term of properties.
Parameters:afile (char *) –
Return type:void
OCC.Materials.materials_MaterialsFile(*args)
  • Sets the location and the name of the file defining the dictionary of materials.
Parameters:afile (char *) –
Return type:void
  • Returns the location and the name of the dictionary file of materials.
Return type:char *
OCC.Materials.materials_NumberOfMaterials()
  • Returns the number of materials previously stored in the dictionary.
Return type:int