c4d.DescID ¶

An ID class for description elements. Contains a stack of DescLevel objects.

The description ID is used to exactly identify a parameter value.

Definition ¶

class c4d. DescID ¶

• DescID.__init__()
• DescID.__str__()

• DescID.__lshift__()
• DescID.__getitem__()

• DescID.__eq__()
• DescID.__ne__()

• DescID.SetId()
• DescID.PushId()
• DescID.PopId()

• DescID.GetDepth()

• DescID.Write()
• DescID.Read()

• DescID.GetHashCode()

• DescID.IsPartOf()

Members ¶

DescID. __init__ ( [ id1 [ , id2 , id3 ] ] ) ¶

Create a DescID instance up to three levels:

dId = c4d.DescID()
dId = c4d.DescID(dId) #copy constructor
dId = c4d.DescID(10) #first level with given ID
dId = c4d.DescID(DescLevel(10), DescLevel(20), DescLevel(30)) #set three levels
							

Parameters:	id1 ( c4d.DescLevel ) – First level. id2 ( c4d.DescLevel ) – Second level. id3 ( c4d.DescLevel ) – Third level.

DescID. __str__ ( ) ¶

Returns the DescID as string. Called if str() is wrapped around an instance of DescID . (See __str__ ):

dId = c4d.DescID(c4d.DescLevel(30))
print dId                # output '(30, 0, 0)'
							

Return type:	str
Returns:	The DescID as string.

DescID. __lshift__ ( self , other ) ¶

Returns the result of popping shift levels from the bottom of the stack:

dId = c4d.DescID(c4d.DescLevel(30), c4d.DescLevel(40), c4d.DescLevel(50))
dId<<2
							

Parameters:	other ( int ) – Number of levels to pop.
Raises:	IndexError – If other is out of range : 0<=other< GetDepth() .
Return type:	c4d.DescID
Returns:	Result.

DescID. __getitem__ ( self , key ) ¶

Returns the level at position key in the stack:

dId = c4d.DescID(c4d.DescLevel(30), c4d.DescLevel(40), c4d.DescLevel(50))
diD[2]
							

Parameters:	key ( int ) – The position.
Raises:	IndexError – If other is out of range : 0<=key< GetDepth() .
Return type:	c4d.DescLevel
Returns:	The level at the specified position.

DescID. __eq__ ( self , other ) ¶

Checks if all levels are equal.

DescID. __ne__ ( self , other ) ¶

The reverse of __eq__ .

DescID. SetId ( subid ) ¶

Set the highest level to subid .

Parameters:	subid ( c4d.DescLevel ) – New toplevel.

DescID. PushId ( subid ) ¶

Push a new level onto the stack.

Parameters:	subid ( c4d.DescLevel ) – Level to push.

DescID. PopId ( ) ¶

Pops the highest level from the stack.

DescID. GetDepth ( ) ¶

Return the depth.

Return type:	int
Returns:	The depth.

DescID. Write ( hf ) ¶

Writes the description to a file.

Parameters:	hf ( c4d.storage.HyperFile ) – The hyperfile to write to.

DescID. Read ( hf ) ¶

Reads the description from a file.

Parameters:	hf ( c4d.storage.HyperFile ) – The hyperfile to read from.
Return type:	bool
Returns:	True if successful, otherwise False.

DescID. GetHashCode ( ) ¶

New in version R17.048.

Gets a hash code for the description ID.

Return type:	int
Returns:	The hash code.

DescID. IsPartOf ( cmp ) ¶

New in version R18.020.

Checks if the description ID is part of cmp and returns the length of the match.

Parameters:	cmp (int, list or DescID ) – The super description ID. Changed in version R18.057. Can be a int, list or DescID
Return type:	tuple(bool,int)
Returns:	A tuple with the following information: bool: True if the description ID matches a lowest part of cmp , otherwise False . int: The length of the match.

Table Of Contents

• c4d.DescID
  • Definition
  • Members