Skip to content

Home Information - Your home, your data, organized.

Python

Added limits for SVG positions + Debouncing for position saves.

Anthony Cassandra2ef8a7273d51
diff --git a/src/hi/apps/collection/collection_manager.py b/src/hi/apps/collection/collection_manager.py
index 22fe8b04..42a0604c 100644
--- a/src/hi/apps/collection/collection_manager.py
+++ b/src/hi/apps/collection/collection_manager.py
@@ -257,7 +257,10 @@ class CollectionManager(Singleton):
location = location_view.location,
).first()
if collection_position:
- collection_position_form = CollectionPositionForm( instance = collection_position )
+ collection_position_form = CollectionPositionForm(
+ location_view.location.svg_position_bounds,
+ instance = collection_position,
+ )
collection_edit_data = CollectionEditData( collection = collection )
return CollectionDetailsData(
diff --git a/src/hi/apps/collection/edit/views.py b/src/hi/apps/collection/edit/views.py
index c68fca25..e8e0d75f 100644
--- a/src/hi/apps/collection/edit/views.py
+++ b/src/hi/apps/collection/edit/views.py
@@ -167,6 +167,7 @@ class CollectionPositionEditView( View, CollectionViewMixin ):
raise Http404( request )
collection_position_form = forms.CollectionPositionForm(
+ location.svg_position_bounds,
request.POST,
instance = collection_position,
)
diff --git a/src/hi/apps/collection/transient_models.py b/src/hi/apps/collection/transient_models.py
index 25ef6d48..3ba69628 100644
--- a/src/hi/apps/collection/transient_models.py
+++ b/src/hi/apps/collection/transient_models.py
@@ -2,7 +2,7 @@ from dataclasses import dataclass, field
from typing import List
from hi.apps.collection.edit.forms import CollectionForm, CollectionPositionForm
-from hi.apps.entity.enums import EntityGroupType, EntityType
+from hi.apps.entity.enums import EntityGroupType
from hi.apps.entity.models import Entity
from hi.apps.monitor.transient_models import EntityStatusData
diff --git a/src/hi/apps/common/svg_forms.py b/src/hi/apps/common/svg_forms.py
index 6d95a89f..7b22e7ba 100644
--- a/src/hi/apps/common/svg_forms.py
+++ b/src/hi/apps/common/svg_forms.py
@@ -20,8 +20,25 @@ class SvgDecimalFormField( forms.FloatField ):
a Decimal field in to form is fraught with issues if submitting
higher precision than Decimal field allows.
"""
- pass
-
+ def __init__( self,
+ *args,
+ min_value : float = None,
+ max_value : float = None,
+ **kwargs ):
+ super().__init__(*args, **kwargs)
+ self.min_value = min_value
+ self.max_value = max_value
+ return
+
+ def clean( self, value ):
+ value = super().clean( value )
+ if value is not None:
+ if ( self.min_value is not None ) and ( value < self.min_value ):
+ value = self.min_value
+ if ( self.max_value is not None ) and ( value > self.max_value ):
+ value = self.max_value
+ return value
+
class SvgFileForm(forms.Form):
"""
diff --git a/src/hi/apps/common/svg_models.py b/src/hi/apps/common/svg_models.py
index b24d50a1..c688a5bd 100644
--- a/src/hi/apps/common/svg_models.py
+++ b/src/hi/apps/common/svg_models.py
@@ -216,3 +216,16 @@ class SvgStatusStyle:
if self.stroke_dasharray:
result['stroke-dasharray'] = ','.join([ str(x) for x in self.stroke_dasharray ])
return result
+
+
+@dataclass
+class SvgItemPositionBounds:
+ min_x : float
+ min_y : float
+ max_x : float
+ max_y : float
+ min_scale : float
+ max_scale : float
+
+
+
diff --git a/src/hi/apps/entity/edit/forms.py b/src/hi/apps/entity/edit/forms.py
index 0b95dd25..6e17da51 100644
--- a/src/hi/apps/entity/edit/forms.py
+++ b/src/hi/apps/entity/edit/forms.py
@@ -3,7 +3,6 @@ from typing import Type
from django import forms
-from hi.apps.entity.enums import EntityStateValue
from hi.apps.entity.models import EntityPosition, EntityState
from hi.apps.location.edit.forms import LocationItemPositionForm
diff --git a/src/hi/apps/entity/edit/views.py b/src/hi/apps/entity/edit/views.py
index a282fbc8..06435607 100644
--- a/src/hi/apps/entity/edit/views.py
+++ b/src/hi/apps/entity/edit/views.py
@@ -133,8 +133,9 @@ class EntityPositionEditView( View, EntityViewMixin ):
)
except EntityPosition.DoesNotExist:
raise Http404( request )
-
+
entity_position_form = forms.EntityPositionForm(
+ location.svg_position_bounds,
request.POST,
instance = entity_position,
)
diff --git a/src/hi/apps/entity/entity_manager.py b/src/hi/apps/entity/entity_manager.py
index 74daf3e3..1377da63 100644
--- a/src/hi/apps/entity/entity_manager.py
+++ b/src/hi/apps/entity/entity_manager.py
@@ -73,7 +73,10 @@ class EntityManager(Singleton):
location = location_view.location,
).first()
if entity_position:
- entity_position_form = EntityPositionForm( instance = entity_position )
+ entity_position_form = EntityPositionForm(
+ location_view.location.svg_position_bounds,
+ instance = entity_position,
+ )
entity_pairing_list = EntityPairingManager().get_entity_pairing_list( entity = entity )
diff --git a/src/hi/apps/entity/transient_models.py b/src/hi/apps/entity/transient_models.py
index 58f34f6a..57ef163a 100644
--- a/src/hi/apps/entity/transient_models.py
+++ b/src/hi/apps/entity/transient_models.py
@@ -116,3 +116,4 @@ class EntityStateHistoryData:
'controller_history_list_map': self.controller_history_list_map,
}
return context
+
diff --git a/src/hi/apps/location/edit/forms.py b/src/hi/apps/location/edit/forms.py
index c756ec2d..a7008be0 100644
--- a/src/hi/apps/location/edit/forms.py
+++ b/src/hi/apps/location/edit/forms.py
@@ -6,6 +6,7 @@ from django.conf import settings
from hi.apps.attribute.forms import AttributeForm, AttributeUploadForm
from hi.apps.common.svg_forms import SvgDecimalFormField, SvgFileForm
+from hi.apps.common.svg_models import SvgItemPositionBounds
from hi.apps.location.enums import LocationViewType, SvgStyleName
from hi.apps.location.models import (
@@ -149,7 +150,7 @@ class LocationViewGeometryForm( forms.ModelForm ):
svg_rotate = SvgDecimalFormField()
-
+
class LocationItemPositionForm( forms.ModelForm ):
# Abstract class. Subclasses need to add model. e.g.,
#
@@ -164,16 +165,34 @@ class LocationItemPositionForm( forms.ModelForm ):
'svg_scale',
'svg_rotate',
)
-
- svg_x = SvgDecimalFormField(
- label = 'X',
- )
- svg_y = SvgDecimalFormField(
- label = 'Y',
- )
- svg_scale = SvgDecimalFormField(
- label = 'Scale',
- )
- svg_rotate = SvgDecimalFormField(
- label = 'Rotate',
- )
+
+ def __init__( self, svg_position_bounds : SvgItemPositionBounds, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+
+ self.fields['svg_x'] = SvgDecimalFormField(
+ label = 'X',
+ min_value = svg_position_bounds.min_x,
+ max_value = svg_position_bounds.max_x,
+ )
+ self.fields['svg_y'] = SvgDecimalFormField(
+ label = 'Y',
+ min_value = svg_position_bounds.min_y,
+ max_value = svg_position_bounds.max_y,
+ )
+ self.fields['svg_scale'] = SvgDecimalFormField(
+ label = 'Scale',
+ min_value = svg_position_bounds.min_scale,
+ max_value = svg_position_bounds.max_scale,
+ )
+ self.fields['svg_rotate'] = SvgDecimalFormField(
+ label = 'Rotate',
+ )
+ return
+
+ def clean_svg_rotate( self ):
+ svg_rotate = self.cleaned_data['svg_rotate']
+ if svg_rotate is not None:
+ svg_rotate = svg_rotate % 360
+ if svg_rotate < 0:
+ svg_rotate += 360
+ return svg_rotate
diff --git a/src/hi/apps/location/models.py b/src/hi/apps/location/models.py
index 3716ed3b..33083479 100644
--- a/src/hi/apps/location/models.py
+++ b/src/hi/apps/location/models.py
@@ -3,7 +3,7 @@ import logging
from django.core.files.storage import default_storage
from django.db import models
-from hi.apps.common.svg_models import SvgDecimalField, SvgViewBox
+from hi.apps.common.svg_models import SvgDecimalField, SvgItemPositionBounds, SvgViewBox
from hi.apps.attribute.models import AttributeModel
from hi.enums import ItemType
from hi.models import ItemTypeModelMixin
@@ -69,6 +69,18 @@ class Location( models.Model, ItemTypeModelMixin ):
self.svg_view_box_str = str(svg_view_box)
return
+ @property
+ def svg_position_bounds( self ):
+ svg_view_box = self.svg_view_box
+ return SvgItemPositionBounds(
+ min_x = svg_view_box.x,
+ min_y = svg_view_box.y,
+ max_x = svg_view_box.x + svg_view_box.width,
+ max_y = svg_view_box.y + svg_view_box.height,
+ min_scale = 0.1,
+ max_scale = 25.0,
+ )
+
def delete( self, *args, **kwargs ):
""" Deleting SVG file from MEDIA_ROOT on best effort basis. Ignore if fails. """
diff --git a/src/hi/static/js/svg-icon.js b/src/hi/static/js/svg-icon.js
index e24027b2..a6edde4d 100644
--- a/src/hi/static/js/svg-icon.js
+++ b/src/hi/static/js/svg-icon.js
@@ -63,7 +63,8 @@
const MOUSE_MOVE_ZOOM_SCALE_FACTOR = 175.0; // Number of pixels moved to double or halve size
const MOUSE_WHEEL_ROTATE_DEGREES = 10.0;
const KEYPRESS_ROTATE_DEGREES = 10.0;
-
+ const POSITION_API_CALL_DEBOUNCE_MS = 400;
+
const API_EDIT_LOCATION_ITEM_POSITION_URL = '/location/edit/location-item/position';
const SvgActionStateType = {
@@ -81,6 +82,9 @@
let gLastMousePosition = { x: 0, y: 0 };
let gIgnoreCLick = false; // Set by mouseup handling when no click handling should be done
+ let positionApiCallDebounceTimer = null;
+ let lastPositionApiCallTime = 0;
+
function _handleMouseDown( event ) {
if ( ! Hi.isEditMode ) { return false; }
@@ -437,24 +441,6 @@
gSvgIconDragData = null;
}
- function saveIconSvgPosition( element ) {
-
- let transform = element.attr('transform');
- let { scale, translate, rotate } = Hi.svgUtils.getSvgTransformValues( transform );
-
- const baseSvgElement = $(Hi.BASE_SVG_SELECTOR);
- const center = Hi.svgUtils.getSvgCenterPoint( element, baseSvgElement );
-
- let svgItemId = element.attr('id');
- let data = {
- svg_x: center.x,
- svg_y: center.y,
- svg_scale: scale.x,
- svg_rotate: rotate.angle,
- };
- AN.post( `${API_EDIT_LOCATION_ITEM_POSITION_URL}/${svgItemId}`, data );
- }
-
function createIconActionEditData( actionState ) {
if ( gSelectedIconSvgGroup ) {
let transform = gSelectedIconSvgGroup.attr('transform');
@@ -474,12 +460,8 @@
}
}
- function revertIconAction( element ) {
+ function abortIconAction( element ) {
if ( gSvgIconActionEditData ) {
- setSvgTransformAttr( gSvgIconActionEditData.element,
- gSvgIconActionEditData.scaleStart,
- gSvgIconActionEditData.translateStart,
- gSvgIconActionEditData.rotateStart );
gSvgIconActionEditData = null;
}
}
@@ -497,7 +479,7 @@
if ( gSvgIconActionState != SvgActionStateType.SCALE ) {
return;
}
- revertIconAction();
+ abortIconAction();
}
function iconActionScaleFromMouseWheel( event ) {
@@ -508,13 +490,14 @@
}
console.log( `Scale multiplier = ${scaleMultiplier} [${gSvgIconActionEditData.isScaling}]` );
adjustIconScale( gSvgIconActionEditData.element, scaleMultiplier );
+ saveIconSvgPositionDebouncer( gSelectedIconSvgGroup );
}
function iconActionScaleUpFromKeypress() {
if ( gSelectedIconSvgGroup ) {
let scaleMultiplier = 1.0 + ( KEYPRESS_ZOOM_SCALE_FACTOR_PERCENT / 100.0 );
adjustIconScale( gSelectedIconSvgGroup, scaleMultiplier );
- saveIconSvgPosition( gSelectedIconSvgGroup );
+ saveIconSvgPositionDebouncer( gSelectedIconSvgGroup );
}
}
@@ -522,7 +505,7 @@
if ( gSelectedIconSvgGroup ) {
let scaleMultiplier = 1.0 - ( KEYPRESS_ZOOM_SCALE_FACTOR_PERCENT / 100.0 );
adjustIconScale( gSelectedIconSvgGroup, scaleMultiplier );
- saveIconSvgPosition( gSelectedIconSvgGroup );
+ saveIconSvgPositionDebouncer( gSelectedIconSvgGroup );
}
}
@@ -606,16 +589,19 @@ Original (str): ${transformStr}
deltaAngle = -1.0 * MOUSE_WHEEL_ROTATE_DEGREES;
}
adjustIconRotate( gSvgIconActionEditData.element, deltaAngle );
+ saveIconSvgPositionDebouncer( gSelectedIconSvgGroup );
}
function iconActionRotateRightFromKeypress() {
let deltaAngle = KEYPRESS_ROTATE_DEGREES;
adjustIconRotate( gSelectedIconSvgGroup, deltaAngle );
+ saveIconSvgPositionDebouncer( gSelectedIconSvgGroup );
}
function iconActionRotateLeftFromKeypress() {
let deltaAngle = -1.0 * KEYPRESS_ROTATE_DEGREES;
adjustIconRotate( gSelectedIconSvgGroup, deltaAngle );
+ saveIconSvgPositionDebouncer( gSelectedIconSvgGroup );
}
function adjustIconRotate( svgIconElement, deltaAngle ) {
@@ -646,12 +632,42 @@ Original (str): ${transformStr}
if ( gSvgIconActionState != SvgActionStateType.ROTATE ) {
return;
}
- revertIconAction();
+ abortIconAction();
}
function setSvgTransformAttr( element, scale, translate, rotate ) {
let newTransform = `scale(${scale.x} ${scale.y}) translate(${translate.x}, ${translate.y}) rotate(${rotate.angle}, ${rotate.cx}, ${rotate.cy})`;
element.attr('transform', newTransform);
}
-
+
+ function saveIconSvgPositionDebouncer( element ) {
+ const currentTime = Date.now();
+ const timeSinceLastApiCall = currentTime - lastPositionApiCallTime;
+
+ clearTimeout( positionApiCallDebounceTimer );
+ positionApiCallDebounceTimer = setTimeout(() => {
+ saveIconSvgPosition( element );
+ lastPositionApiCallTime = Date.now();
+ }, POSITION_API_CALL_DEBOUNCE_MS );
+ }
+
+ function saveIconSvgPosition( element ) {
+
+ let transform = element.attr('transform');
+ let { scale, translate, rotate } = Hi.svgUtils.getSvgTransformValues( transform );
+
+ const baseSvgElement = $(Hi.BASE_SVG_SELECTOR);
+ const center = Hi.svgUtils.getSvgCenterPoint( element, baseSvgElement );
+
+ let svgItemId = element.attr('id');
+ let data = {
+ svg_x: center.x,
+ svg_y: center.y,
+ svg_scale: scale.x,
+ svg_rotate: rotate.angle,
+ };
+ AN.post( `${API_EDIT_LOCATION_ITEM_POSITION_URL}/${svgItemId}`, data );
+ }
+
+
})();
diff --git a/src/hi/static/js/svg-location.js b/src/hi/static/js/svg-location.js
index 49397b4f..1888668e 100644
--- a/src/hi/static/js/svg-location.js
+++ b/src/hi/static/js/svg-location.js
@@ -56,7 +56,7 @@
const PIXEL_MOVE_DISTANCE_SCALE_FACTOR = 250.0;
const KEYPRESS_ZOOM_SCALE_FACTOR_PERCENT = 10.0;
const MOUSE_WHEEL_ZOOM_SCALE_FACTOR_PERCENT = 10.0;
- const ZOOM_API_CALL_DEBOUNCE_MS = 500;
+ const ZOOM_API_CALL_DEBOUNCE_MS = 400;
const LOCATION_VIEW_EDIT_PANE_SELECTOR = '#hi-location-view-edit';
const API_EDIT_LOCATION_VIEW_GEOMETRY_URL = '/location/edit/location-view/geometry';
@@ -113,7 +113,7 @@
|| ( distanceY > CURSOR_MOVEMENT_THRESHOLD_PIXELS )) {
gSvgTransformData.isDragging = true;
if ( gSvgTransformType == SvgTransformType.SCALE ) {
- updateScale( event );
+ updateScaleFromMouseMove( event );
} else if( gSvgTransformType == SvgTransformType.ROTATE ) {
updateRotation( event );
} else {
@@ -372,7 +372,7 @@
$(gSelectedLocationViewSvg).attr( Hi.SVG_ACTION_STATE_ATTR_NAME, gSvgTransformType );
}
- function updateScale( event ) {
+ function updateScaleFromMouseMove( event ) {
if ( Hi.DEBUG ) { console.log( `updateScale [${MODULE_NAME}]` ); }
if ( gSvgTransformData == null ) {