DisplayObject class parent interfaces¶

What interfaces are these?¶

The parent attribute is the getter property. This attribute becomes a Stage instance or a container instance like a Sprite instance.

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=150,
    stage_height=200,
    stage_elem_id="stage",
)

sprite: ap.Sprite = ap.Sprite()
rectangle: ap.Rectangle = sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)

assert isinstance(sprite.parent, ap.Stage)
assert isinstance(sprite.graphics.parent, ap.Sprite)
assert isinstance(rectangle.parent, ap.Graphics)

The remove_from_parent interface removes self-instance from the parent (and not be displayed on the stage).

Basic usage of the remove_from_parent interface¶

The remove_from_parent method interface (no argument options) removes the self-instance from the parent. A Removed instance is not displayed until any parent adds it again.

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=150,
    stage_height=150,
    stage_elem_id="stage",
)

sprite: ap.Sprite = ap.Sprite()
rectangle: ap.Rectangle = sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)

# Remove the rectangle from the parent, and nothing displays
# on the stage.
rectangle.remove_from_parent()

ap.save_overall_html(dest_dir_path="display_object_remove_from_parent_basic_usage/")

See also¶

• add_child and remove_child interfaces

parent API¶

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface summary]

Get a parent instance that has an add_child and remove_child interfaces.

[Returns]

• parent: any parent instance (ChildMixIn) or None

  • Parent instance with add_child and remove_child interfaces. If this instance does not have a parent instance (not added child), this interface returns None.

[Examples]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite_1: ap.Sprite = ap.Sprite()
>>> sprite_1.graphics.begin_fill(color=ap.Color("#0af"))
>>> rectangle: ap.Rectangle = sprite_1.graphics.draw_rect(
...     x=50, y=50, width=50, height=50
... )
>>> sprite_2: ap.Sprite = ap.Sprite()
>>> sprite_2.add_child(rectangle)
>>> rectangle.parent == sprite_2
True

remove_from_parent API¶

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface signature] remove_from_parent(self) -> None

[Interface summary]

Remove this instance from a parent.

[Raises]

• ValueError: If a parent is None (there is no parent).