Show Menu
TOPICS×

class s7vampy.obj.Group(factory, parent, obj)

Object groups usually contain one or more objects or object groups. Object groups are used to build the object hierarchy of a vignette.
Derived from Object .
Object groups can also be used to make it easy to apply the same material to multiple objects in a vignette.
For instance if you have a shirt that is built up from multiple masks you could end up with the following hierarchy:
  • shirt
    • left
    • right
    • collar
When you render the vignette on a server or using the render page in Image Authoring, you can apply a material to the shirt group, which applies that material to the individual objects.
add_flat_object ( * name *, * mask *, * *_ *, * **keywords *)
Parameters:
  • name( str )
    Name of the object.
  • mask( s7vampy.image.Image )
    Mask of the object.
  • overlap( bool )
    Defaults to false. Overlap is a keyword argument and needs to be specified explicitly. Specifyoverlap=True to create an overlap object.
Returns:
New object.
Add a flat texturable object to this group.
The provided mask must be the same size as the vignette view.
add_group (name)
Parameters:
name ( str )
Name of the new object group.
Returns:
New object group.
Add an object group to this group.
add_nontexturable_object ( * name *, * mask *, * *_ *, * **keywords *)
Parameters:
  • name( str )
    Name of the object.
  • mask( s7vampy.image.Image )
    Mask image associated with the object.
  • overlap( bool )
    Defaults to false. Overlap is a keyword argument and needs to be specified explicitly. Specify overlap=True to create an overlap object.
Returns:
New object.
Add a non-texturable object to this group.
The provided mask must be the same size as the vignette view.
add_static_object ( * name *, * mask *)
Parameters:
Returns:
New object.
Add a static object to this group.
The provided mask must be the same size as the vignette view.
add_static_overlap_object ( * name *, * image *)
Parameters:
Returns:
New object.
Add a static overlap object to this group.
The provided static overlap image must be the same size as the vignette view.
add_surface_object ( * name *, * mask *, * *_ *, * **keywords *)
Parameters:
  • name( str )
    Name of the object.
  • mask( s7vampy.image.Image ) - Mask of the object.
  • overlap( bool )
    Defaults to false. Overlap is a keyword argument and needs to be specified explicitly. Specify overlap=True to create an overlap object.
Returns:
New object.
Add a surface texturable (flowline) object to this group.
The provided mask must be the same size as the vignette view.
children [ObjectList]
List of objects and object groups that are children of this object group ( [ObjectList](../../../c-s7vampy-api-reference/c-classes/c-objects/r-class-s7vampy-obj-objectlist.md#reference-0b83540fd1e9495c8d00f19bfb27656b) ).
imagemap [s7vampy.path.Path]
Image map associated with the object group ( [s7vampy.path.Path](../../../c-s7vampy-api-reference/c-classes/c-path/r-class-s7vampy-path-path.md#reference-2e340c8f51db4053877c584873a41bea) ).