Skip to content

BREP

cadwork.facet_list

facet_list

Source code in cadwork/facet_list.py
class facet_list:
    def count(self) -> int:
        """count
        Args:

        Returns:
            int
        """

    def at(self, index: int) -> point_3d:
        """at
        Args:
            index ( int): index

        Returns:
            point_3d
        """

    def get_external_polygon(self, index: int) -> vertex_list:
        """get external polygon
        Args:
            index ( int): index

        Returns:
            vertex_list
        """

    def get_internal_polygons(self, index: int) -> polygon_list:
        """get internal polygons
        Args:
            index ( int): index

        Returns:
            polygon_list
        """

    def get_vertices_for_reference_face(self) -> vertex_list:
        """get vertices for reference face
        Args:

        Returns:
            vertex_list
        """

    def get_external_polygon_for_reference_face(self) -> vertex_list:
        """get external polygon for reference face
        Args:

        Returns:
            vertex_list
        """

    def get_internal_polygons_for_reference_face(self) -> polygon_list:
        """get internal polygons for reference face
        Args:

        Returns:
            polygon_list
        """

    def get_normal_vector(self, index: int) -> point_3d:
        """get normal vector
        Args:
            index ( int): index

        Returns:
            point_3d
        """

    def get_distance_to_origin(self, index: int) -> float:
        """get distance to origin
        Args:
            index ( int): index

        Returns:
            float
        """

at(self, index)

at

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
<module 'cadwork.point_3d' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/point_3d.py'>

point_3d

Source code in cadwork/facet_list.py
def at(self, index: int) -> point_3d:
    """at
    Args:
        index ( int): index

    Returns:
        point_3d
    """

count(self)

count

Returns:

Type Description
int

int

Source code in cadwork/facet_list.py
def count(self) -> int:
    """count
    Args:

    Returns:
        int
    """

get_distance_to_origin(self, index)

get distance to origin

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
float

float

Source code in cadwork/facet_list.py
def get_distance_to_origin(self, index: int) -> float:
    """get distance to origin
    Args:
        index ( int): index

    Returns:
        float
    """

get_external_polygon(self, index)

get external polygon

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
<module 'cadwork.vertex_list' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/vertex_list.py'>

vertex_list

Source code in cadwork/facet_list.py
def get_external_polygon(self, index: int) -> vertex_list:
    """get external polygon
    Args:
        index ( int): index

    Returns:
        vertex_list
    """

get_external_polygon_for_reference_face(self)

get external polygon for reference face

Returns:

Type Description
<module 'cadwork.vertex_list' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/vertex_list.py'>

vertex_list

Source code in cadwork/facet_list.py
def get_external_polygon_for_reference_face(self) -> vertex_list:
    """get external polygon for reference face
    Args:

    Returns:
        vertex_list
    """

get_internal_polygons(self, index)

get internal polygons

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
<module 'cadwork.polygon_list' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/polygon_list.py'>

polygon_list

Source code in cadwork/facet_list.py
def get_internal_polygons(self, index: int) -> polygon_list:
    """get internal polygons
    Args:
        index ( int): index

    Returns:
        polygon_list
    """

get_internal_polygons_for_reference_face(self)

get internal polygons for reference face

Returns:

Type Description
<module 'cadwork.polygon_list' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/polygon_list.py'>

polygon_list

Source code in cadwork/facet_list.py
def get_internal_polygons_for_reference_face(self) -> polygon_list:
    """get internal polygons for reference face
    Args:

    Returns:
        polygon_list
    """

get_normal_vector(self, index)

get normal vector

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
<module 'cadwork.point_3d' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/point_3d.py'>

point_3d

Source code in cadwork/facet_list.py
def get_normal_vector(self, index: int) -> point_3d:
    """get normal vector
    Args:
        index ( int): index

    Returns:
        point_3d
    """

get_vertices_for_reference_face(self)

get vertices for reference face

Returns:

Type Description
<module 'cadwork.vertex_list' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/vertex_list.py'>

vertex_list

Source code in cadwork/facet_list.py
def get_vertices_for_reference_face(self) -> vertex_list:
    """get vertices for reference face
    Args:

    Returns:
        vertex_list
    """

cadwork.edge_list

edge_list

Source code in cadwork/edge_list.py
class edge_list:
    def count(self) -> int:
        """count
        Args:

        Returns:
            int
        """

    def at(self, index: int) -> point_3d:
        """at
        Args:
            index ( int): index

        Returns:
            point_3d
        """

at(self, index)

at

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
<module 'cadwork.point_3d' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/point_3d.py'>

point_3d

Source code in cadwork/edge_list.py
def at(self, index: int) -> point_3d:
    """at
    Args:
        index ( int): index

    Returns:
        point_3d
    """

count(self)

count

Returns:

Type Description
int

int

Source code in cadwork/edge_list.py
def count(self) -> int:
    """count
    Args:

    Returns:
        int
    """

cadwork.polygon_list

polygon_list

Source code in cadwork/polygon_list.py
class polygon_list:
    def count(self) -> int:
        """count
        Args:

        Returns:
            int
        """

    def at(self, index: int) -> point_3d:
        """at
        Args:
            index ( int): index

        Returns:
            point_3d
        """

at(self, index)

at

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
<module 'cadwork.point_3d' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/point_3d.py'>

point_3d

Source code in cadwork/polygon_list.py
def at(self, index: int) -> point_3d:
    """at
    Args:
        index ( int): index

    Returns:
        point_3d
    """

count(self)

count

Returns:

Type Description
int

int

Source code in cadwork/polygon_list.py
def count(self) -> int:
    """count
    Args:

    Returns:
        int
    """

cadwork.vertex_list

vertex_list

Source code in cadwork/vertex_list.py
class vertex_list:
    def count(self) -> int:
        """count
        Args:

        Returns:
            int
        """

    def at(self, index: int) -> point_3d:
        """at
        Args:
            index ( int): index

        Returns:
            point_3d
        """

    def append(self, vertex: point_3d) -> None:
        """append
        Args:
            vertex ( point_3d): vertex

        Returns:
            None
        """

append(self, vertex)

append

Parameters:

Name Type Description Default
vertex point_3d

vertex

required

Returns:

Type Description
None

None

Source code in cadwork/vertex_list.py
def append(self, vertex: point_3d) -> None:
    """append
    Args:
        vertex ( point_3d): vertex

    Returns:
        None
    """

at(self, index)

at

Parameters:

Name Type Description Default
index int

index

required

Returns:

Type Description
<module 'cadwork.point_3d' from '/home/docs/checkouts/readthedocs.org/user_builds/cwapi3dpython/checkouts/latest/src/cadwork/point_3d.py'>

point_3d

Source code in cadwork/vertex_list.py
def at(self, index: int) -> point_3d:
    """at
    Args:
        index ( int): index

    Returns:
        point_3d
    """

count(self)

count

Returns:

Type Description
int

int

Source code in cadwork/vertex_list.py
def count(self) -> int:
    """count
    Args:

    Returns:
        int
    """

rendering: show_root_heading: false show_source: true