Hyperbola

Declaration

class declaracad.occ.draw.Hyperbola(parent=None, **kwargs)[source]

Bases: Edge

Creates a Hyperbola.

Attributes:
major_radius: Float

The major radius of the hyperbola

minor_radius: Float

The minor radius of the hyperbola

Methods

activate_bottom_up()

Initialize the proxy on the bottom-up activation pass.

activate_proxy()

Activate the proxy object tree.

activate_top_down()

Initialize the proxy on the top-down activation pass.

child_added(child)

A reimplemented child added event handler.

child_moved(child)

A method invoked when a child is moved in the object.

child_removed(child)

A reimplemented child removed event handler.

destroy()

A reimplemented destructor.

find(name[, regex])

Find the first object in the subtree with the given name.

find_all(name[, regex])

Find all objects in the subtree with the given name.

freeze

Freeze the atom to prevent further modifications to its attributes.

get_member

Get the named member for the atom.

get_value_at(t[, derivative])

Get the value of the curve derivative at t.

has_observer

Get whether the atom has the given observer for a given topic.

has_observers

Get whether the atom has observers for a given topic.

initialize()

A reimplemented initializer.

insert_children(before, insert)

Insert children into this object at the given location.

members()

Get the members dictionary for the type.

notifications_enabled

Get whether notification is enabled for the atom.

notify

Call the registered observers for a given topic with positional and keyword arguments.

observe

Register an observer callback to observe changes on the given topic(s).

parent_changed(old, new)

A method invoked when the parent of the object changes.

render()

Generates and returns the actual shape from the declaration.

root_object()

Get the root object for this hierarchy.

set_notifications_enabled

Enable or disable notifications for the atom.

set_parent(parent)

Set the parent for this object.

suppress_notifications()

Disable member notifications within in a context.

traverse([depth_first])

Yield all of the objects in the tree, from this object down.

traverse_ancestors([root])

Yield all of the objects in the tree, from this object up.

unobserve

Unregister an observer callback for the given topic(s).

line_style

Notes

The hyperbola is positioned in the space by the coordinate system A2 such that:

  • the origin of A2 is the center of the hyperbola,

  • the “X Direction” of A2 defines the major axis of the hyperbola, that is,

    the major radius MajorRadius is measured along this axis, and

  • the “Y Direction” of A2 defines the minor axis of the hyperbola, that is,

    the minor radius MinorRadius is measured along this axis.

This class does not prevent the creation of a hyperbola where: - MajorAxis is equal to MinorAxis, or - MajorAxis is less than MinorAxis. Exceptions Standard_ConstructionError

if MajorAxis or MinorAxis is negative.

Raises ConstructionError if MajorRadius < 0.0 or MinorRadius < 0.0 Raised

if MajorRadius < 0.0 or MinorRadius < 0.0

Examples

Wire:
Hyperbola:

major_radius = 5 minor_radius = 3

major_radius

Major radius of the hyperbola

minor_radius

Minor radius of the hyperbola

proxy

Reference to the implementation control

Implementation

class declaracad.occ.impl.occ_hyperbola.OccHyperbola[source]

Bases: OccEdge, ProxyHyperbola

Attributes:
ais_shape
curve
declaration
displayed
is_active

Test whether or not the proxy is fully activated.

location
reference
shape
tdf_label
topology
viewer

Methods

activate_bottom_up()

Activate the proxy tree for the bottom-up pass.

activate_top_down()

Activate the proxy for the top-down pass.

child_added(child)

Handle a child being added to the object.

child_removed(child)

Handle a child being removed from the object.

child_shapes()

Iterator of all child shapes

children()

Get the child objects for this object.

create_shape()

Create the toolkit shape for the proxy object.

destroy()

Destroy the proxy and any of its resources.

freeze

Freeze the atom to prevent further modifications to its attributes.

get_first_child()

Return shape to apply the operation to.

get_member

Get the named member for the atom.

get_transform()

Create a transform which rotates the default axis to align with the normal given by the position

has_observer

Get whether the atom has the given observer for a given topic.

has_observers

Get whether the atom has observers for a given topic.

init_layout()

Initialize the layout of the toolkit shape.

init_shape()

Initialize the state of the toolkit widget.

members()

Get the members dictionary for the type.

notifications_enabled

Get whether notification is enabled for the atom.

notify

Call the registered observers for a given topic with positional and keyword arguments.

observe

Register an observer callback to observe changes on the given topic(s).

parent()

Get the parent proxy object for this object.

set_notifications_enabled

Enable or disable notifications for the atom.

suppress_notifications()

Disable member notifications within in a context.

unobserve

Unregister an observer callback for the given topic(s).

walk_shapes([ignore_display])

Iterator of all child shapes

clear_focus

ensure_hidden

ensure_visible

focus_next_child

focus_previous_child

get_bounding_box

get_value_at

has_focus

make_edge

on_shape_changed

parent_shape

request_relayout

restyle

set_as_wire

set_axis

set_background

set_color

set_direction

set_display

set_enabled

set_focus

set_font

set_foreground

set_line_style

set_line_width

set_major_radius

set_maximum_size

set_minimum_size

set_minor_radius

set_position

set_reverse

set_solve

set_status_tip

set_surface

set_texture

set_tool_tip

set_transparency

set_visible

create_shape()[source]

Create the toolkit shape for the proxy object.

This method is called during the top-down pass, just before the ‘init_shape()’ method is called. This method should create the toolkit widget and assign it to the ‘widget’ attribute.

reference

Update the class reference