units

Unit conversion utilities for Revit.

Attributes

Functions

format_area(area_value, doc=None)

Return formatted area value in document units.

Parameters:

Name	Type	Description	Default
area_value	float	area value	required
doc	Document	Revit document, defaults to current	None

Returns:

Type	Description
str	formatted value

Source code in pyrevitlib/pyrevit/revit/units.py

def format_area(area_value, doc=None):
    """Return formatted area value in document units.

    Args:
        area_value (float): area value
        doc (DB.Document, optional): Revit document, defaults to current

    Returns:
        (str): formatted value
    """
    doc = doc or DOCS.doc
    if HOST_APP.is_newer_than(2021):
        return DB.UnitFormatUtils.Format(units=doc.GetUnits(),
                                         specTypeId=DB.SpecTypeId.Area,
                                         value=area_value,
                                         forEditing=False)
    else:
        return DB.UnitFormatUtils.Format(units=doc.GetUnits(),
                                         unitType=DB.UnitType.UT_Area,
                                         value=area_value,
                                         maxAccuracy=False,
                                         forEditing=False)

format_slope(slope_value, doc=None)

Return formatted slope value in document units.

Parameters:

Name	Type	Description	Default
slope_value	float	slope value	required
doc	Document	Revit document, defaults to current	None

Returns:

Type	Description
str	formatted value

Source code in pyrevitlib/pyrevit/revit/units.py

def format_slope(slope_value, doc=None):
    """Return formatted slope value in document units.

    Args:
        slope_value (float): slope value
        doc (DB.Document, optional): Revit document, defaults to current

    Returns:
        (str): formatted value
    """
    doc = doc or DOCS.doc
    if HOST_APP.is_newer_than(2021):
        return DB.UnitFormatUtils.Format(units=doc.GetUnits(),
                                         specTypeId=DB.SpecTypeId.Slope,
                                         value=slope_value,
                                         forEditing=False)
    else:
        return DB.UnitFormatUtils.Format(units=doc.GetUnits(),
                                         unitType=DB.UnitType.UT_Slope,
                                         value=slope_value,
                                         maxAccuracy=False,
                                         forEditing=False)

project_to_viewport(xyz, view)

Project a point to viewport coordinates.

Parameters:

Name	Type	Description	Default
xyz	XYZ	point to project	required
view	View	target view	required

Returns:

Type	Description
UV	[description]

Source code in pyrevitlib/pyrevit/revit/units.py

def project_to_viewport(xyz, view):
    """Project a point to viewport coordinates.

    Args:
        xyz (DB.XYZ): point to project
        view (DB.View): target view

    Returns:
        (DB.UV): [description]
    """
    plane = _create_view_plane(view)
    uv, _ = plane.Project(xyz)
    return uv

project_to_world(uv, view)

Get view-based point (UV) back to model coordinates.

Parameters:

Name	Type	Description	Default
uv	UV	point on a view	required
view	View	view to get coordinates from	required

Returns:

Type	Description
XYZ	point in world coordinates

Source code in pyrevitlib/pyrevit/revit/units.py

def project_to_world(uv, view):
    """Get view-based point (UV) back to model coordinates.

    Args:
        uv (DB.UV): point on a view
        view (DB.View): view to get coordinates from

    Returns:
        (DB.XYZ): point in world coordinates
    """
    plane = _create_view_plane(view)
    trf = DB.Transform.Identity
    trf.BasisX = plane.XVec
    trf.BasisY = plane.YVec
    trf.BasisZ = plane.Normal
    trf.Origin = plane.Origin
    return trf.OfPoint(DB.XYZ(uv.U, uv.V, 0))

get_spec_name(forge_id)

Returns the measurable spec name for the given unit id.

Parameters:

Name	Type	Description	Default
forge_id	ForgeTypeId	Unit id	required

Returns:

Type	Description
str	Spec name

Source code in pyrevitlib/pyrevit/revit/units.py

def get_spec_name(forge_id):
    """Returns the measurable spec name for the given unit id.

    Args:
        forge_id (DB.ForgeTypeId): Unit id

    Returns:
        (str): Spec name
    """
    if HOST_APP.is_newer_than(2021) \
            and DB.UnitUtils.IsMeasurableSpec(forge_id):
        return DB.UnitUtils.GetTypeCatalogStringForSpec(forge_id)
    return ""

get_unit_name(forge_id)

Returns the unit name for the given unit id.

Parameters:

Name	Type	Description	Default
forge_id	ForgeTypeId	Unit id	required

Returns:

Type	Description
str	Unit name

Source code in pyrevitlib/pyrevit/revit/units.py

def get_unit_name(forge_id):
    """Returns the unit name for the given unit id.

    Args:
        forge_id (DB.ForgeTypeId): Unit id

    Returns:
        (str): Unit name
    """
    if HOST_APP.is_newer_than(2021) \
            and DB.UnitUtils.IsUnit(forge_id):
        return DB.UnitUtils.GetTypeCatalogStringForUnit(forge_id)
    return ""