Navigation

c4d.BaseObject

The base class of objects.

Here is an example how to create and edit objects:

import c4d

obj = c4d.BaseObject(c4d.Ocube) # Create new cube
obj.SetRelPos(c4d.Vector(20))   # Set position of cube
doc.InsertObject(obj)           # Insert object in document
c4d.EventAdd()                  # Send global event message

Definition

class c4d.BaseObject

Members

BaseObject.__init__(type)

Initialize a new BaseObject in memory.

Parameters: type (int) – The object type : Object Types.
Return type: BaseObject
Returns: The new base object.
BaseObject.GetAbsPos()

Returns the absolute position of the object. These will be absolute local coordinates within its parent object. See also Freeze Transformations.

Return type: Vector
Returns: The absolute object position.
BaseObject.SetAbsPos(v)

Sets the absolute local position of the object within its parent. If the object has no parent then these will be world coordinates. See also Freeze Transformations.

Parameters: v (Vector) – The absolute object position.
BaseObject.GetAbsScale()

eturns the absolute scale of the object. These will be relative to the objects parent if it has one. See also Freeze Transformations.

Return type: Vector
Returns: The absolute object scale.
BaseObject.SetAbsScale(v)

Sets the absolute scale of the object relative to its parent object if it has one. See also Freeze Transformations.

Parameters: v (Vector) – The absolute object scale.
BaseObject.GetAbsRot()

Returns the absolute HPB rotation of the object relative to any parent object. See also Freeze Transformations.

Return type: Vector
Returns: The absolute object rotation.
BaseObject.SetAbsRot(v)

Sets the absolute HPB rotation of the object relative to any parent object. See also Freeze Transformations.

Parameters: v (Vector) – The absolute object rotation.
BaseObject.GetFrozenPos()

Returns the frozen position of the object. See also Freeze Transformations.

Return type: Vector
Returns: The frozen object position.
BaseObject.SetFrozenPos(v)

Sets the frozen postion of the object. See also Freeze Transformations.

Parameters: v (Vector) – The frozen object position.
BaseObject.GetFrozenScale()

Returns the frozen scale of the object. See also Freeze Transformations.

Return type: Vector
Returns: The frozen object scale.
BaseObject.SetFrozenScale(v)

Sets the frozen scale of the object. See also Freeze Transformations.

Parameters: v (Vector) – The frozen object scale.
BaseObject.GetFrozenRot()

Returns the frozen HPB rotation of the object. See also Freeze Transformations.

Return type: Vector
Returns: The frozen object rotation.
BaseObject.SetFrozenRot(v)

Sets the frozen HPB rotation of the object. See also Freeze Transformations.

Parameters: v (Vector) – The frozen object rotation.
BaseObject.GetRelPos()

Returns the relative position of the object. See also Freeze Transformations.

Return type: Vector
Returns: The relative object position.
BaseObject.SetRelPos(v)

Set the relative position of the object. See also Freeze Transformations.

Parameters: v (Vector) – The relative object position.
BaseObject.GetRelScale()

Returns the relative scale of the object. See also Freeze Transformations.

Return type: Vector
Returns: The relative object scale.
BaseObject.SetRelScale(v)

Sets the relative scale of the object. See also Freeze Transformations.

Parameters: v (Vector) – The relative object scale.
BaseObject.GetRelRot()

Returns the relative HPB rotation of the object. See also Freeze Transformations.

Return type: Vector
Returns: The relative object rotation.
BaseObject.SetRelRot(v)

Sets the relative HPB rotation of the object. See also Freeze Transformations.

Parameters: v (Vector) – The relative object rotation.
BaseObject.GetMl()

Get the local matrix that represents the objects position, scale and rotation.

Return type: Matrix
Returns: The object’s local matrix.
BaseObject.SetMl(m)

Set the local matrix that represents the objects position, scale and rotation.

Parameters: m (Matrix) – The object’s new local matrix.
BaseObject.GetFrozenMln()

Returns the frozen and normalized matrix of the object. See also Freeze Transformations.

Parameters: m (Matrix) – The object’s frozen and normalized matrix.
BaseObject.GetRelMln()

Returns the relative and normalized matrix of the object. See also Freeze Transformations.

Return type: Matrix
Returns: The object’s relative and normalized matrix.
BaseObject.GetRelMl()

Returns the relative matrix of the object. See also Freeze Transformations.

Return type: Matrix
Returns: The object’s relative matrix.
BaseObject.SetRelMl(m)

Sets the relative matrix of the object. See also Freeze Transformations.

Parameters: m (Matrix) – The object’s new relative matrix.
BaseObject.GetMg()

Get the world (global) matrix that represents the objects position, scale and rotation.

Note

This will only work if the object is attached to a document. Virtual objects in caches and deform caches are not attached to a document, so this function cannot be used for those objects.

Return type: Matrix
Returns: The object’s world matrix.
BaseObject.SetMg(m)

Set the world (global) matrix that represents the objects position, scale and rotation.

Parameters: m (Matrix) – The object’s new world matrix.
BaseObject.GetMln()

Get the local normalized matrix that represents the objects position, scale and rotation.

Return type: Matrix
Returns: The object’s normalized local matrix.
BaseObject.GetMgn()

Get the global normalized matrix that represents the objects position, scale and rotation.

Return type: Matrix
Returns: The object’s normalized world matrix.
BaseObject.GetUpMg()

Get the global matrix of the parent object that represents the objects position, scale and rotation. If the object has no parent object then this matrix will be a unit matrix.

Return type: Matrix
Returns: The parent object’s world matrix.
BaseObject.CopyMatrixTo(dst)

Copy the matrix to another object.

Parameters: dst (BaseObject) – The destintation object.
BaseObject.GetMp()

Bounding box center (vector), in local space.

Return type: Vector
Returns: The bounding box center.
BaseObject.GetRad()

This is the bounding box radius (x/y/z) of the object, this works for all objects and is faster than manually finding the bounds of even polygon objects, the radius is internally cached.

Return type: Vector
Returns: The bounding box width, height and depth.
BaseObject.GetEditorMode()

Returns the state of the editor dot for this object.

Return type: int
Returns: The editor mode:
MODE_ON The object is enabled regardless of the state of any parent objects.
MODE_OFF The object is disabled regardless of the state of any parent objects.
MODE_UNDEF The object is enabled by default, but the state of the parent objects is used if they are enabled or disabled.
BaseObject.SetEditorMode(mode)

Set the state of the editor dot for this object.

Parameters: mode (int) –

The editor mode:

MODE_ON The object is enabled regardless of the state of any parent objects.
MODE_OFF The object is disabled regardless of the state of any parent objects.
MODE_UNDEF The object is enabled by default, but the state of the parent objects is used if they are enabled or disabled.
BaseObject.GetRenderMode()

Returns the state of the render dot for this object.

Return type: int
Returns: The render mode:
MODE_ON The object is enabled regardless of the state of any parent objects.
MODE_OFF The object is disabled regardless of the state of any parent objects.
MODE_UNDEF The object is enabled by default, but the state of the parent objects is used if they are enabled or disabled.
BaseObject.SetRenderMode(mode)

Set the render state for this object.

Parameters: mode (int) –

The render mode:

MODE_ON The object is enabled regardless of the state of any parent objects.
MODE_OFF The object is disabled regardless of the state of any parent objects.
MODE_UNDEF The object is enabled by default, but the state of the parent objects is used if they are enabled or disabled.
BaseObject.GetTag(type[, nr=0])

Get a tag of a certain type associated with this object.

Parameters:
  • type (int) – The type of tag to fetch from the object:
  • nr (int) – The starting tag index to find of this type.
Return type:

BaseTag
Returns:

The requested tag, or None if no tags of the requested type are available.

Note

If you request a specific number that is not available then None will be returned even if there is a tag of that type with a different index.
BaseObject.KillTag(type[, nr=0])

Removes a tag from the object and free its resources.

Parameters:
  • type (int) – The type of tag to fetch from the object:
  • nr (int) – The starting tag index to find of this type.
BaseObject.GetRealSpline()

Get a real spline representation of a primitive spline object. This can for example be used to calculate the length of the spline. If the object is a real spline it returns this. Otherwise None.

Note

The matrix of the returned object mustn’t be used. Use the matrix of self instead.

Return type: SplineObject
Returns: The created spline object.
BaseObject.GetVisibility(parent)

The object’s visibility depends upon its parent, if it has no visibility track this will return the parent’s visibility which is passed. The range of values are 0.0.

Note

In the editor only a visibility of 0.0 can be noticed but all other intermediate values are visualized in the renderer only.

Parameters: float – The parent objects visibility.
Return type: float
Returns: The visibility.
BaseObject.SetDeformMode(mode)

Set the state of the deformation/generator tick.

Parameters: mode (bool) – True to enable the generator/deformer object.
BaseObject.GetDeformMode()

Returns the state of the deformation/generator tick.

Return type: bool
Returns: True if the generator/deformer object is enabled.
BaseObject.GetUniqueIP()

Get the ip of the object.

Return type: int
Returns: The object IP number.
BaseObject.SetUniqueIP(ip)

Set the ip of the object.

Parameters: ip (int) – The object IP number.
BaseObject.CopyTagsTo(dest, visible, variable, hierarchial)

Set the ip of the object.

Parameters:
  • dest (BaseObject) – The destination object where to copy all tags from self.
  • visible (bool) – True if the tag is visible.
  • variable (bool) – True if the tag must be variable.
  • hierarchial (bool) – True if the tag must be hierarchial.
BaseObject.GetFirstTag()

Returns the first BaseTag of the object.

Return type: BaseTag
Returns: The first tag of the object, otherwise False.
BaseObject.GetTags()

Returns all tags in a list.

Return type: list of type BaseTag
Returns: The list of all tags.
BaseObject.MakeTag(x[, pred])

Create and insert a tag for this object.

Parameters:
  • x (int) – The type of tag to create : see Tag Types.
  • pred (BaseTag) – The tag will insert after pred.
Return type:

BaseTag
Returns:

The new tag.
BaseObject.MakeVariableTag(x, count[, pred])

Create a variable tag for this object.

Parameters:
  • x (int) –

    The type of tag to create:

    Tpoint Point tag.
    Tparticle Particle data tag.
    Tpolygon Polygon data tag.
    Tuvw UVW data tag.
    Tsegment Segment data tag.
    Tline Line data tag.
    Tsticktexture Stick texture tag.
  • count (int) – The size of the variable tags data.
  • pred (BaseTag) – The tag will insert after pred.
Return type:

BaseTag
Returns:

The new tag.
BaseObject.InsertTag(tp[, pred=None])

Attach a BaseTag to BaseObject.

Parameters:
  • tp (BaseTag) – The tag which will be attached.
  • pred (BaseTag) – tp will insert after pred.
Return type:

BaseTag
Returns:

The new tag.
BaseObject.GetTagDataCount(type)

Get the variable tag data count.

Parameters: type (int) –

The type of tag:

Tpoint Point tag.
Tparticle Particle data tag.
Tpolygon Polygon data tag.
Tuvw UVW data tag.
Tsegment Segment data tag.
Tline Line data tag.
Tsticktexture Stick texture tag.
Return type: int
Returns: The number of elements in the variable tag.
BaseObject.IsDirty(flags)

Check if the object has been changed since the last time the object was touched.

Parameters: flags (int) –

The object part to check

DIRTY_MATRIX The matrix was changed.
DIRTY_DATA The container was changed.
DIRTY_SELECT Checks all valid selections of the object, e.g. points, edge, polys.
DIRTY_CACHE Checks if the cache was rebuilt.
DIRTY_CHILDREN The children are dirty.
Return type: bool
Returns: True if the object is dirty.
BaseObject.SetDirty(flags)

Check if the object has been changed since the last time the object was touched.

Parameters: flags (int) – See parameters at IsDirty().
BaseObject.Touch()

Mark object to be used by a generator; automatically resets ‘dirty’.

BaseObject.SetPhong(on, anglelimit, angle)

Set the phong smoothing for the object.

Note

This function will delete any existing Phong tag. If on is set to True it will create a new Phong tag.

Parameters:
  • on (bool) – False removes the phong tag from the object.
  • anglelimit (bool) – True if angle should be used.
  • angle (float) – The phong angle.
Return type:

bool
Returns:

Success of changing the smoothing.
BaseObject.GetDeformCache()

Get the previously built cache that has been deformed by an active deformer.

It is important to understand the concept of how the deformer cache operates. For each object in the hierarchy that generates a polygonal cache a deformer cache could also have been created by an active deformer object.

A simple example will help to see how this works.

Take the simple hierarchy shown above, the array generator object creates a virtual hierarchy in the cache, this can be retrieved using GetCache(). This hierarchy is:

From each of the Cube objects a further cache is generated, this time polygonal:

From these the deformer object generates a deformed polygon cache:

Giving a total hierarchy of:

When a deformer becomes active every object/cache object gets a deform cache (if it was a polygonal object). The deformer cache is always polygonal and is only ever a single object.

It is important to remember that the caches are always built after all plugins and expressions have been called. If you need to get access to the virtual objects to obtain a polygonal based object it is generally advised to use SendModelingCommand() with MCOMMAND_CURRENTSTATETOOBJECT. This will rebuild the cache for the passed object if needed, and then clone the polygonal objects for you.

Note

You shouldn’t modify the deform cache. Use a deformer ObjectData plugin instead.

Return type: BaseObject
Returns: The return may be None if the cache is not available or is not yet built.
BaseObject.GetCache([hierarchyhelp=None])

Get the object from the previously built cache.

Note

Remember situations can be quite complex in CINEMA 4D. For instance GetCache() could return a list of objects. You can use the following helper routine to make things easier. It browses through this rather complex hierarchy of objects and caches recusrsively. Please remember to only use the above routine if you are sure that the caches are really build. It would be for instance not safe to use in a Command plugin since the user could have stoped the scene redraw and the building of caches.

Parameters: hierarchyhelp (PyCObject) – A reference to the HierarchyHelp dictionary.
Return type: BaseObject
Returns: The objects previously built cache or None

Note

Only for special cases a HierarchyHelp must be passed.
BaseObject.CheckCache(hierarchyhelp)

Check if cache is built, if it matches the requirements (polygonized/isoparm, level of detail etc.). It returns the dirty status of the cache.

Note

This function must only be called within ObjectData.GetVirtualObjects() of a generator object.

Parameters: hierarchyhelp (PyCObject) – A reference to the HierarchyHelp dictionary.
Return type: bool
Returns: True if the cache is valid.
BaseObject.GetHighlightHandle(bd)

Checks if a highlight handle has been hit, by returning the ID previously returned by ObjectData.DetectHandle(). The handle can then be drawn in the highlight mode.

Parameters: bd (BaseDraw) – A base draw.
Return type: int
Returns: The handle ID.
BaseObject.NewDependenceList()

Start a new dependence list. These enable you to keep track of changes made to any children.

Note

The object must be children of your object.

BaseObject.CompareDependenceList()

Compares if anything in the dependence list has changed.

Return type: bool
Returns: True if the list has not changed (are the same).
BaseObject.AddDependence(hh, op)

Add a child object to the dependence list. Usually this will be child objects that are used by a generator object.

Parameters:
BaseObject.TouchDependenceList()

Mark all the objects in the dependence list that they will be replaced by the generator.

BaseObject.SearchHierarchy(op)

Check if the object is a child of op.

Parameters: op (BaseObject) – Check within this object’s hierarchy.
Return type: bool
Returns: True if the object is a child of op, otherwise False.
BaseObject.GetAndCheckHierarchyClone(hh, op, flags, allchildren)

Check and generate a clone of the child objects of a parent generator. This is similar to GetHierarchyClone() except that it will check if the hierarchy is dirty and if not it will not need to generate a new clone.

Parameters:
  • hh (HierarchyHelp) – Usually passed through from a calling function, for example from ObjectData.GetVirtualObjects().
  • op (BaseObject) – The object to start the clone from, usually the first child of the parent object.
  • flags (int) –

    The flags for the generation of the cloned chain, the values are:

    HIERARCHYCLONEFLAGS_0 None.
    HIERARCHYCLONEFLAGS_ASIS Objects unchanged. (Used by e.g. ArrayObject.)
    HIERARCHYCLONEFLAGS_ASPOLY Objects cloned as polygons. (Used by e.g. HyperNURBS.)
    HIERARCHYCLONEFLAGS_ASLINE Objects cloned as line objects.
    HIERARCHYCLONEFLAGS_ASSPLINE Objects cloned as splines.
  • allchildren (bool) – True if all children should be used in the check.
Return type:

dict{clone: BaseObject, dirty: bool}
Returns:

The cloned object and a dirty flag: True if some part of the child objects in the chain has changed, or False if nothing has changed.
BaseObject.GetHierarchyClone(hh, op, flags)

Generate a clone of the child objects of a parent generator.

The result you get by GetAndCheckHierarchyClone() will be a chain of objects with various types. Passing HIERARCHYCLONEFLAGS_ASLINE e.g. will force all splines to be converted, but not every object in the chain will be of type Oline; some objects like PolygonObject cannot be converted, also there are Onull.

Parameters:
  • hh (HierarchyHelp) – Usually passed through from a calling function, for example from ObjectData.GetVirtualObjects().
  • op (BaseObject) – The object to start the clone from, usually the parent object itself.
  • flags (int) –

    The flags for the generation of the cloned chain, the values are:

    HIERARCHYCLONEFLAGS_0 None.
    HIERARCHYCLONEFLAGS_ASIS Objects unchanged. (Used by e.g. ArrayObject.)
    HIERARCHYCLONEFLAGS_ASPOLY Objects cloned as polygons. (Used by e.g. HyperNURBS.)
    HIERARCHYCLONEFLAGS_ASLINE Objects cloned as line objects.
    HIERARCHYCLONEFLAGS_ASSPLINE Objects cloned as splines.
Return type:

dict{clone: BaseObject, dirty: bool}
Returns:

The cloned object and a dirty flag: True if some part of the child objects in the chain has changed, or False if nothing has changed.

Table Of Contents

Navigation

© Copyright 2012, MAXON Computer GmbH. Last updated on May 17, 2012. Created using Sphinx 1.1.3.