c4d.modules.character.builder.ComponentObject¶

class c4d.modules.character.builder.ComponentObject¶: See also

Python Character Component Tag Manual

Methods Signatures

`ComponentObject.GetName()`	Get the component’s name.
`ComponentObject.GetUp()`	Get the main object of the parent component.
`ComponentObject.GetDown()`	Get the main object of the first child component.
`ComponentObject.GetNext()`	Get the main object of the next component.
`ComponentObject.GetPrev()`	Get the main object of the previous component.
`ComponentObject.CountComponent()`	Count child components.
`ComponentObject.FindComponent()`	Find a specific child component by name.
`ComponentObject.FindObject()`	Find an object within the component by name.
`ComponentObject.GetComponent()`	Get the component.
`ComponentObject.GetObject()`	Get the main object of the component.
`ComponentObject.GetObjects()`	Get a container with all the objects for this component.
`ComponentObject.GetTag()`	Get the component tag for this component.

Methods Documentation

ComponentObject.GetName(self, ident)¶

Get the component’s name.

Parameters: ident (bool) – If true, displays name and unique identifier.
Return type: str
Returns: The name.

ComponentObject.GetUp(self)¶

Get the main object of the parent component.

Return type: Optional[c4d.BaseObject]
Returns: The main object of the parent component.

ComponentObject.GetDown(self)¶

Get the main object of the first child component.

Return type: Optional[c4d.BaseObject]
Returns: The main object of the first child component.

ComponentObject.GetNext(self)¶

Get the main object of the next component.

Return type: Optional[c4d.BaseObject]
Returns: The main object of the next component.

ComponentObject.GetPrev(self)¶

Get the main object of the previous component.

Return type: Optional[c4d.BaseObject]
Returns: The main object of the previous component.

ComponentObject.CountComponent(self, name, ident, mirrored, down)¶

Count child components.

Parameters

name (str) – String to match.
ident (bool) – If true, displays name and unique identifier.
mirrored (bool) – If true, matches only mirrored components.
down (bool) – If true, matches recursively (includes children).

Return type

int

Returns

Number of matches.

ComponentObject.FindComponent(self, name, ident, mirrored, down)¶

Find a specific child component by name.

Parameters

name (str) – String to match.
ident (bool) – If true, displays name and unique identifier.
mirrored (bool) – If true, matches only mirrored components.
down (bool) – If true, matches recursively (includes children).

Return type

c4d.modules.character.builder.ComponentObject

Returns

The first matched object.

ComponentObject.FindObject(self, name)¶

Find an object within the component by name.

Parameters: name (str) – String to match.
Return type: c4d.BaseObject
Returns: The first matched object.

ComponentObject.GetComponent(self)¶

Get the component.

Return type: c4d.modules.character.builder.Component
Returns: The related component.

ComponentObject.GetObject(self)¶

Get the main object of the component.

Return type: c4d.BaseObject
Returns: The related object.

ComponentObject.GetObjects(self, type)¶

Get a container with all the objects for this component.

Parameters

type (int) –

Indicates which objects to get:

Note

These constants are defined in the c4d.modules.character.builder module so c4d.modules.character.builder.COMPONENT_OBJECT_GETOBJECTS_TYPE_ALL should be used and not c4d.COMPONENT_OBJECT_GETOBJECTS_TYPE_ALL.

Symbol ID	Description
COMPONENT_OBJECT_GETOBJECTS_TYPE_ALL	All objects.
COMPONENT_OBJECT_GETOBJECTS_TYPE_INCLUDED	Included objects.
COMPONENT_OBJECT_GETOBJECTS_TYPE_MAIN	Direct Child objects.
COMPONENT_SELECTION_MODES_UVEDGES	New in version S22: UV Edges selection mode.

Return type

c4d.BaseContainer

Returns

The BaseContainer filled with object links.

ComponentObject.GetTag(self)¶

Get the component tag for this component.

Return type: c4d.BaseTag
Returns: The component tag.